FaxStore

Our Discord

Weblutions Documentation / FaxStore / Blogs API

Blogs API

The Blog API for FaxStore facilitates the management of blog content, including creating, deleting, updating, and retrieving blog posts. This API streamlines the process of maintaining and publishing content on your site.

Table of Contents

Get All Blogs

GET/api/blogs

Returns am array of all created blog posts.

Authorization

Name	Type	Required	Description
authorization	String	required

Responses

200OKjson

View response body

[
  {
    "id": 3,
    "userId": "183355725132050432",
    "username": "John Doe",
    "title": "Why FaxStore is the best store!",
    "catId": 1,
    "image": "/image",
    "content": "MD content of the blog",
    "shortUrl": "dsd",
    "createdAt": "1723728274051",
    "edited": "1723728274051"
  },
  ...
]

404Not Foundplaintext

View response body

Blogs not found.

Examples

curl -X GET 'https://api.example.com/api/blogs' \
  -H 'Authorization: Bearer YOUR_API_TOKEN'

const response = await fetch('https://api.example.com/api/blogs', {
  "method": "GET",
  "headers": {
    "Authorization": "Bearer YOUR_API_TOKEN"
  }
})
const data = await response.json()

import requests

response = requests.get('https://api.example.com/api/blogs', headers={
    "Authorization": "Bearer YOUR_API_TOKEN"
})
data = response.json()

<?php
$context = stream_context_create([
  'http' => [
    'method' => 'GET',
    'header' => "Authorization: Bearer YOUR_API_TOKEN"
  ]
]);

$response = file_get_contents('https://api.example.com/api/blogs', false, $context);
$data = json_decode($response, true);

Get Blog

GET/api/blog/:id

Returns the blog associated with the ID provided.

Authorization

Name	Type	Required	Description
authorization	String	required

Path parameters

Name	Type	Required	Description
id	String	required	A blog ID

Responses

200OKjson

View response body

{
  "id": 3,
  "userId": "183355725132050432",
  "username": "John Doe",
  "title": "Why FaxStore is the best store!",
  "catId": 1,
  "image": "/image",
  "content": "MD content of the blog",
  "shortUrl": "dsd",
  "createdAt": "1723728274051",
  "edited": "1723728274051"
}

404Not Foundjson

View response body

Blog ID not found.

Examples

curl -X GET 'https://api.example.com/api/blog/123' \
  -H 'Authorization: Bearer YOUR_API_TOKEN'

const response = await fetch('https://api.example.com/api/blog/123', {
  "method": "GET",
  "headers": {
    "Authorization": "Bearer YOUR_API_TOKEN"
  }
})
const data = await response.json()

import requests

response = requests.get('https://api.example.com/api/blog/123', headers={
    "Authorization": "Bearer YOUR_API_TOKEN"
})
data = response.json()

<?php
$context = stream_context_create([
  'http' => [
    'method' => 'GET',
    'header' => "Authorization: Bearer YOUR_API_TOKEN"
  ]
]);

$response = file_get_contents('https://api.example.com/api/blog/123', false, $context);
$data = json_decode($response, true);

Create Blog Post

POST/api/blog

Authorization

Name	Type	Required	Description
authorization	String	required

Request body

Name	Type	Required	Description
userId	String	required	A user ID to associate the post with.
username	String	required	The display name of the author.
title	String	required	The blog post name.
url	String	required	The URL identifier for the post.
catId	Integer	optional	The category ID to place the blog post within
content	String	required	The body content of the blog post. Markdown is supported.
image	String	optional	A complete image URL for a banner image.

Responses

200OKjson

View response body

{
  "id": 6,
  "userId": "61",
  "username": "Test User",
  "title": "Test Blog",
  "catId": 0,
  "image": "",
  "content": "test contyent **here!**",
  "shortUrl": "testbloggg",
  "createdAt": "1723777120536",
  "edited": null
}

400Bad Requestplaintext

View response body

Missing required body items - userId, username, title, and url are required.

404Not Foundplaintext

View response body

Blog ID not found after creation.

Examples

curl -X POST 'https://api.example.com/api/blog' \
  -H 'Authorization: Bearer YOUR_API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
  "userId": "123",
  "username": "example_username",
  "title": "example_title",
  "url": "https://example.com/image.png",
  "catId": 123,
  "content": "example_content",
  "image": "https://example.com/image.png"
}'

const response = await fetch('https://api.example.com/api/blog', {
  "method": "POST",
  "headers": {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Content-Type": "application/json"
  },
  "body": JSON.stringify({
  "userId": "123",
  "username": "example_username",
  "title": "example_title",
  "url": "https://example.com/image.png",
  "catId": 123,
  "content": "example_content",
  "image": "https://example.com/image.png"
})
})
const data = await response.json()

import requests

response = requests.post('https://api.example.com/api/blog', headers={
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Content-Type": "application/json"
}, json={
    "userId": "123",
    "username": "example_username",
    "title": "example_title",
    "url": "https://example.com/image.png",
    "catId": 123,
    "content": "example_content",
    "image": "https://example.com/image.png"
})
data = response.json()

<?php
$context = stream_context_create([
  'http' => [
    'method' => 'POST',
    'header' => "Authorization: Bearer YOUR_API_TOKEN\\r\\nContent-Type: application/json",
    'content' => json_encode([
        "userId" => "123",
        "username" => "example_username",
        "title" => "example_title",
        "url" => "https://example.com/image.png",
        "catId" => 123,
        "content" => "example_content",
        "image" => "https://example.com/image.png"
    ])
  ]
]);

$response = file_get_contents('https://api.example.com/api/blog', false, $context);
$data = json_decode($response, true);

Delete Blog

DELETE/api/blog/:id

Authorization

Name	Type	Required	Description
authorization	String	required

Path parameters

Name	Type	Required	Description
id	Integer	required	A blog post ID.

Responses

201OKplaintext

View response body

OK

404Not Foundjson

View response body

Blog ID not found.

Examples

curl -X DELETE 'https://api.example.com/api/blog/123' \
  -H 'Authorization: Bearer YOUR_API_TOKEN'

const response = await fetch('https://api.example.com/api/blog/123', {
  "method": "DELETE",
  "headers": {
    "Authorization": "Bearer YOUR_API_TOKEN"
  }
})
const data = await response.json()

import requests

response = requests.delete('https://api.example.com/api/blog/123', headers={
    "Authorization": "Bearer YOUR_API_TOKEN"
})
data = response.json()

<?php
$context = stream_context_create([
  'http' => [
    'method' => 'DELETE',
    'header' => "Authorization: Bearer YOUR_API_TOKEN"
  ]
]);

$response = file_get_contents('https://api.example.com/api/blog/123', false, $context);
$data = json_decode($response, true);

Document History

Loading version history...