FaxStore

Prerequisites

API

Apps (Previously Extensions)

Configuration File

Developer Mode

Developer Tools & Resources

Enable Debug Mode

Features

Integrations

License System Extension

Self-Hosted Installation & Setup

Updating FaxStore Manually

Our Discord

Weblutions Documentation / FaxStore / Miscellaneous API

Miscellaneous API

The Misc API for FaxStore enables retrieval of minor settings and documents such as Terms of Service. It provides easy access to essential site configuration and legal information.

Table of Content

Get Terms of Service

GET/api/misc/tos

Returns the store Terms of Service text with any formatting used in HTML.

Authorization

Name	Type	Required	Description
authorization	String	required

Responses

200OKplaintext

View response body

"Terms of service string"

404Not Foundplaintext

View response body

TOS/Settings not found.

Examples

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

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

import requests

response = requests.get('https://api.example.com/api/misc/tos', 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/misc/tos', false, $context);
$data = json_decode($response, true);

GET/api/misc/banner

Returns the stores banner if there is one set including any HTML formatting.

Authorization

Name	Type	Required	Description
authorization	String	required

Responses

200OKplaintext

View response body

"Banner string"

404Not Foundplaintext

View response body

Banner not found.

Examples

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

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

import requests

response = requests.get('https://api.example.com/api/misc/banner', 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/misc/banner', false, $context);
$data = json_decode($response, true);

Document History

Loading version history...

Miscellaneous API

Get Terms of Service

Get Site Banner

Document History