FaxStore

Our Discord

Weblutions Documentation / FaxStore / Accounts API

Accounts API

The Accounts API for FaxStore provides a comprehensive solution for managing user accounts, including creation, deletion, modification, and retrieval of account details. This API ensures secure and efficient handling of user information and authentication processes across the platform.

Table of Contents

Get Single Account

GET/api/account/:id

Returns the user information for the requested account.

Authorization

Name	Type	Required	Description
authorization	String	required

Path parameters

Name	Type	Required	Description
id	String	required	The users displayed ID, or internal database ID

Responses

200OKjson

View response body

{
  "id": 51,
  "userId": "1703144023354",
  "username": "John Doe",
  "userImage": "/images/faxstore.png",
  "userEmail": "john.doe@example.com",
  "createdAt": "1703144023354",
  "banned": 0,
  "ip": "N/A",
  "bio": "Unused Profile Bio",
  "staffnotes": null,
  "authType": "local",
  "disabled": 1,
  "getEmails": 1,
  "cart": null,
  "bitfield": "0"
}

400OKplaintext

View response body

Account ID not found.

Examples

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

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

import requests

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

Get Account Permissions

GET/api/account/:id/permission

Returns a Boolean value whether the user has the provided permission. The function also returns a list of the permissions the user has.

Authorization

Name	Type	Required	Description
authorization	String	required

Path parameters

Name	Type	Required	Description
id	String	required	The users displayed ID, or internal database ID

Query parameters

Name	Type	Required	Description
has	String	optional	A permission name to check for against the users existing permissions

Responses

200OKjson

View response body

{"result": true, "permissions": "VIEW_STAFF_PANEL, MANAGE_LICENSES"}

403No Permissionsjson

View response body

{"result": false, "permissions": "VIEW_STAFF_PANEL, MANAGE_LICENSES"}

404OKplaintext

View response body

Account ID not found.

Examples

curl -X GET 'https://api.example.com/api/account/123/permission?has=example_has' \
  -H 'Authorization: Bearer YOUR_API_TOKEN'

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

import requests

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

Get Account Download Audit Logs

GET/api/account/:id/downloadlogs

Returns an array of all downloads a user has made

Authorization

Name	Type	Required	Description
authorization	String	required

Path parameters

Name	Type	Required	Description
id	String	required	The users displayed ID, or internal database ID

Responses

200OKjson

View response body

[
  {
    "id": 150810089161732100,
    "userId": "282762192544333827",
    "username": "faxes",
    "userEmail": "support@weblutions.com",
    "productID": 19,
    "productName": "Example Product Name",
    "ownedProductEntryID": 213,
    "downloadedFilename": "Example Product Name - faxes.json",
    "orderID": "0",
    "ip": "{ip:'::1',error:true,reason:'Reserved IP Address',reserved:true,version:'IPv6'}",
    "country": "Australia",
    "useragent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64)",
    "lang": "en-AU",
    "device": "Desktop",
    "browser": "Chrome",
    "referrer": "http://weblutions.com/user/",
    "sessionID": "VImPLyVq2t2QPpTjWUS6EAZo1T2WTn-4x",
    "createdAt": "1759635927172"
  }
]

200OKjson

View response body

Examples

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

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

import requests

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

Get Account Orders

GET/api/accounts/:id/orders

Returns an array of orders the account holder has made.

Authorization

Name	Type	Required	Description
authorization	String	required

Path parameters

Name	Type	Required	Description
id	String	required	The user ID to fetch data from.

Responses

200OKjson

View response body

[
  {
    "id": 74,
    "userId": "282762192544333827",
    "username": "John Doe",
    "subtotal": "9.99",
    "total": "9.99",
    "processorFee": "0.00",
    "fee": "0.00",
    "discount": "0.00",
    "object": "{\"title\":\"Cart payment via PayPal\",\"payment\":{\"subtotal\":\"9.99\",\"discount\":\"0.00\",\"total\":\"9.99\",\"promoCode\":null},\"items\":[{\"name\":\"Custom Design  - 2\",\"price\":\"9.99\",\"description\":\"Item type: 1\"}],\"createdAt\":1699931646679}",
    "createdAt": "1699931646679",
    "method": "via PayPal",
    "customer": "{\"id\":\"1DC02600C4769332G\",\"email\":\"sb-h2sue18503054@personal.example.com\",\"name\":\"John Doe\"}",
    "ip": "::1",
    "clientObject": null,
    "ownedID": null
  },
  ...
]

401Unauthorizedplaintext

View response body

You are not authorized to access this resource.

Examples

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

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

import requests

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

Get Account Owned Products

GET/api/accounts/:id/products

Returns an array of all downloable content that the account holder has including packages and custom uploaded files.

Authorization

Name	Type	Required	Description
authorization	String	required

Path parameters

Name	Type	Required	Description
id	String	required	The user ID to fetch data from.

Responses

200OKjson

View response body

[
  {
    "id": 230,
    "userId": "282762192544333827",
    "username": "John Doe",
    "productId": 16,
    "productName": "Design - 2",
    "productPrice": "13.74",
    "createdAt": "1779022994982",
    "license": "/tos",
    "downloads": 0,
    "paymentId": "via Stripe",
    "usingLicenseSystem": 1,
    "customUpload": "",
    "packageId": null
  }
  ...
]

401Unauthorizedplaintext

View response body

You are not authorized to access this resource.

Examples

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

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

import requests

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

Notes:

usingLicenseSystem: indicates that a license can be created for the product. It doesn't mean that one has been created by the user.
customUpload: populates with a file pathway to a custom download. Often within the files directory on the host server - See more at Customer Purchases and Downloads.
packageId: an integer that populates if the product was apart of a package.

Create Account

POST/api/account

Creates a user with the specified data. The account password cannot be set, it is generated and the user will have to reset the password.

Authorization

Name	Type	Required	Description
authorization	String	required

Request body

Name	Type	Required	Description
username	String	required
email	String	required
type	String	required	Account type, must be one of; local, discord, github, google
id	String	required	Optional, the user ID, if not provided one will be generated. If this is a Google, Discord, or GitHub account the services ID should be used.
image	String	optional	An image URL for the profile image of the account.
tebexUsername	String	optional	A Tebex username to link to the account.
banned	Boolean	optional	If true the account will be banned preventing login and IP blocking once any login attempt is made.
disabled	Boolean	optional	If true the account is disabled preventing actions once logged in.

Responses

200OKjson

View response body

{
  "id": 51,
  "userId": "1703144023354",
  "username": "John Doe",
  "userImage": "/images/faxstore.png",
  "userEmail": "john.doe@example.com",
  "createdAt": "1703144023354",
  "banned": 0,
  "ip": "N/A",
  "bio": "Unused Profile Bio",
  "staffnotes": null,
  "authType": "local",
  "disabled": 1,
  "getEmails": 1,
  "cart": null,
  "bitfield": "0"
}

400Missing Body Fieldplaintext

View response body

Missing required body items - X is required.

404Failed GETplaintext

View response body

Account ID not found after creation.

409Conflictplaintext

View response body

uplicate user. User already exist, found userId: x.

Examples

curl -X POST 'https://api.example.com/api/account' \
  -H 'Authorization: Bearer YOUR_API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
  "username": "example_username",
  "email": "user@example.com",
  "type": "example_type",
  "id": "123",
  "image": "https://example.com/image.png",
  "tebexUsername": "example_tebexUsername",
  "banned": true,
  "disabled": true
}'

const response = await fetch('https://api.example.com/api/account', {
  "method": "POST",
  "headers": {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Content-Type": "application/json"
  },
  "body": JSON.stringify({
  "username": "example_username",
  "email": "user@example.com",
  "type": "example_type",
  "id": "123",
  "image": "https://example.com/image.png",
  "tebexUsername": "example_tebexUsername",
  "banned": true,
  "disabled": true
})
})
const data = await response.json()

import requests

response = requests.post('https://api.example.com/api/account', headers={
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Content-Type": "application/json"
}, json={
    "username": "example_username",
    "email": "user@example.com",
    "type": "example_type",
    "id": "123",
    "image": "https://example.com/image.png",
    "tebexUsername": "example_tebexUsername",
    "banned": True,
    "disabled": True
})
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([
        "username" => "example_username",
        "email" => "user@example.com",
        "type" => "example_type",
        "id" => "123",
        "image" => "https://example.com/image.png",
        "tebexUsername" => "example_tebexUsername",
        "banned" => true,
        "disabled" => true
    ])
  ]
]);

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

Update Account

PATCH/api/account/:id

Updates the user with the provided fields.

Authorization

Name	Type	Required	Description
authorization	String	required

Path parameters

Name	Type	Required	Description
id	String	required	The users displayed ID, or internal database ID.

Request body

Name	Type	Required	Description
id	String	optional
username	String	optional
image	String	optional	An image URL for the accounts profile image.
email	String	optional
tebexUsername	String	optional	A Tebex username to link.

Responses

200OKplaintext

View response body

OK

404Not Foundplaintext

View response body

Account ID not found.

Examples

curl -X PATCH 'https://api.example.com/api/account/123' \
  -H 'Authorization: Bearer YOUR_API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
  "id": "123",
  "username": "example_username",
  "image": "https://example.com/image.png",
  "email": "user@example.com",
  "tebexUsername": "example_tebexUsername"
}'

const response = await fetch('https://api.example.com/api/account/123', {
  "method": "PATCH",
  "headers": {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Content-Type": "application/json"
  },
  "body": JSON.stringify({
  "id": "123",
  "username": "example_username",
  "image": "https://example.com/image.png",
  "email": "user@example.com",
  "tebexUsername": "example_tebexUsername"
})
})
const data = await response.json()

import requests

response = requests.patch('https://api.example.com/api/account/123', headers={
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Content-Type": "application/json"
}, json={
    "id": "123",
    "username": "example_username",
    "image": "https://example.com/image.png",
    "email": "user@example.com",
    "tebexUsername": "example_tebexUsername"
})
data = response.json()

<?php
$context = stream_context_create([
  'http' => [
    'method' => 'PATCH',
    'header' => "Authorization: Bearer YOUR_API_TOKEN\\r\\nContent-Type: application/json",
    'content' => json_encode([
        "id" => "123",
        "username" => "example_username",
        "image" => "https://example.com/image.png",
        "email" => "user@example.com",
        "tebexUsername" => "example_tebexUsername"
    ])
  ]
]);

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

Delete Account

DELETE/api/account/:id

Deletes the provided account from FaxStore. This action generally isn't recommended, consider banning the user instead. Associated data for the account is also deleted (i.e. payments, downloads, invoices...)

Authorization

Name	Type	Required	Description
authorization	String	required

Path parameters

Name	Type	Required	Description
id	String	optional	The user ID as it appears in the database.

Responses

201OKplaintext

View response body

(no content)

Examples

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

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

import requests

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

Add Giftcard to Account

POST/api/accounts/:id/giftcards

Add a gift card to an account manually with a custom balance. A gift card code is automatically generated and returned.

Authorization

Name	Type	Required	Description
authorization	String	required

Path parameters

Name	Type	Required	Description
id	String	required	The accounts database ID.

Request body

Name	Type	Required	Description
amount	String	required	The starting balance in dollars (e.g; "10.50").

Responses

200OKjson

View response body

{
  id: 124,
  giftId: "024g024g4T_23r022-241ASFas",
  cost: "0.00",
  userId: "1703144023354",
  username: "John Doe",
  remainingAmount: "19.56"
}

400Missing Fieldsplaintext

View response body

Missing required items - userId, remainingAmount are required.

Examples

curl -X POST 'https://api.example.com/api/accounts/123/giftcards' \
  -H 'Authorization: Bearer YOUR_API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
  "amount": "example_amount"
}'

const response = await fetch('https://api.example.com/api/accounts/123/giftcards', {
  "method": "POST",
  "headers": {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Content-Type": "application/json"
  },
  "body": JSON.stringify({
  "amount": "example_amount"
})
})
const data = await response.json()

import requests

response = requests.post('https://api.example.com/api/accounts/123/giftcards', headers={
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Content-Type": "application/json"
}, json={
    "amount": "example_amount"
})
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([
        "amount" => "example_amount"
    ])
  ]
]);

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

Document History

Loading version history...