FaxStore

Our Discord

Weblutions Documentation / FaxStore / Partners API

Partners API

The partners API allows the creation, fetch, and deletion of partners from FaxStore. This streamlines partners on FaxStore allowing easy migration.

Table of Contents

Get All Partners

GET/api/partners

Returns an array of all partners from the database.

Authorization

Name	Type	Required	Description
authorization	String	required

Responses

200OKjson

View response body

[
  {
    "id": 1,
    "position": 10,
    "partName": "Gigavault",
    "partImage": "/images/partner-YhTxn6yPx2cGsBOhs74kabQ20pjiL43YkPiaR9OAw2SPu.png",
    "partDesc": "Gigavault is a team focused password sharing platform that enables teams to securely share internal information.",
    "partLink": "htttps://gigavault.cloud",
    "editors": "",
    "urlId": "gigavault"
  }
  ...
]

401Unauthorizedplaintext

View response body

You are not authorized to access this resource.

Examples

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

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

import requests

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

Get Partner

GET/api/partners/:id

Returns the requested partner in an object.

Authorization

Name	Type	Required	Description
authorization	String	required

Path parameters

Name	Type	Required	Description
id	String	required	The internal database ID of the partner.

Responses

200OKjson

View response body

{
  "id": 1,
  "position": 10,
  "partName": "Gigavault",
  "partImage": "/images/partner-YhTxn6yPx2cGsBOhs74kabQ20pjiL43YkPiaR9OAw2SPu.png",
  "partDesc": "Gigavault is a team focused password sharing platform that enables teams to securely share internal information.",
  "partLink": "htttps://gigavault.cloud",
  "editors": "",
  "urlId": "gigavault"
}

401Unauthorizedjson

View response body

You are not authorized to access this resource.

Examples

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

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

import requests

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

Create Partner

POST/api/partners

Create a partner with the provided details.

Authorization

Name	Type	Required	Description
authorization	String	required

Request body

Name	Type	Required	Description
name	String	required	The desired name for the partner
link	String	required	An external link that will be presented on the partner page.
position	Integer	optional	A number used to sort partners on the partner page.
about	String	optional	A short description of the partner.
urlId	String	required	The URL identifier for the partner.

Responses

200OKjson

View response body

{
  "id": 1,
  "position": 10,
  "partName": "Gigavault",
  "partImage": "/images/partner-YhTxn6yPx2cGsBOhs74kabQ20pjiL43YkPiaR9OAw2SPu.png",
  "partDesc": "Gigavault is a team focused password sharing platform that enables teams to securely share internal information.",
  "partLink": "htttps://gigavault.cloud",
  "editors": "",
  "urlId": "gigavault"
}

404Not Foundplaintext

View response body

Partner not found after creation. Likely due to a database error.

401Unauthorizedjson

View response body

You are not authorized to access this resource.

Examples

curl -X POST 'https://api.example.com/api/partners' \
  -H 'Authorization: Bearer YOUR_API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "example_name",
  "link": "example_link",
  "position": 123,
  "about": "example_about",
  "urlId": "123"
}'

const response = await fetch('https://api.example.com/api/partners', {
  "method": "POST",
  "headers": {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Content-Type": "application/json"
  },
  "body": JSON.stringify({
  "name": "example_name",
  "link": "example_link",
  "position": 123,
  "about": "example_about",
  "urlId": "123"
})
})
const data = await response.json()

import requests

response = requests.post('https://api.example.com/api/partners', headers={
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Content-Type": "application/json"
}, json={
    "name": "example_name",
    "link": "example_link",
    "position": 123,
    "about": "example_about",
    "urlId": "123"
})
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([
        "name" => "example_name",
        "link" => "example_link",
        "position" => 123,
        "about" => "example_about",
        "urlId" => "123"
    ])
  ]
]);

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

Delete Partner

DELETE/api/partners/:id

Deletes a partner from the database.

Authorization

Name	Type	Required	Description
authorization	String	required

Path parameters

Name	Type	Required	Description
id	String	required	The database ID of the partner to delete.

Responses

201OKplaintext

View response body

(no content)

404Not Foundplaintext

View response body

Partner ID not found.

401Unauthorizedjson

View response body

You are not authorized to access this resource.

Examples

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

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

import requests

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