Brevix

Introduction

Public API documentation for Brevix.

Base URL: https://api.brevix.global

This documentation aims to provide all the information you need to work with our API.

As you scroll, you will see code examples for working with the API in different programming languages 
in the dark area to the right.You can switch the language used with the tabs at the top right.

Authenticating requests

To authenticate requests, include a X-API-KEY header with the value "{YOUR_CLIENT_KEY}".

All authenticated endpoints are marked with a requires authentication badge in the documentation below.

Accounts

Current Plan

GET

https://api.brevix.global

/v1/current-plan

Headers

X-API-KEY:

Example:

{api_key}

X-SIGNATURE:

Example:

{hmac_signature}

X-TIMESTAMP:

Example:

{timestamp}

Content-Type

Example:

application/json

Example:

application/json

Headers

Received response

Example request:

curl --request GET \
    --get "https://api.brevix.global/v1/current-plan" \
    --header "X-API-KEY:: {api_key}" \
    --header "X-SIGNATURE:: {hmac_signature}" \
    --header "X-TIMESTAMP:: {timestamp}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 54
vary: Origin

{
    "error": "API key missing"
}

Download Invoice

GET

https://api.brevix.global

/v1/download-invoice

Headers

X-API-KEY:

Example:

{api_key}

X-SIGNATURE:

Example:

{hmac_signature}

X-TIMESTAMP:

Example:

{timestamp}

Content-Type

Example:

application/json

Example:

application/json

Headers

Received response

Example request:

curl --request GET \
    --get "https://api.brevix.global/v1/download-invoice" \
    --header "X-API-KEY:: {api_key}" \
    --header "X-SIGNATURE:: {hmac_signature}" \
    --header "X-TIMESTAMP:: {timestamp}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 53
vary: Origin

{
    "error": "API key missing"
}

Profile Update

POST

https://api.brevix.global

/v1/update-personal-info

Update Profile for the authenticated user

Expected request fields:

first_name (optional)
last_name (optional)
phone (optional)
profile (optional)
address (optional)

Headers

X-API-KEY:

Example:

{api_key}

X-SIGNATURE:

Example:

{hmac_signature}

X-TIMESTAMP:

Example:

{timestamp}

Content-Type

Example:

multipart/form-data

Example:

application/json

Body Parameters

first_name

string

Example:

architecto

last_name

string

Example:

architecto

phone

string

Must be at least 10 characters. Must not be greater than 20 characters.

Example:

ngzmiyvdljnikhwa

image

file

Must be an image. Must not be greater than 2048 kilobytes.

Example:

/tmp/phpmbhlNw

address

string

Example:

architecto

Headers

Body

Received response

Example request:

curl --request POST \
    "https://api.brevix.global/v1/update-personal-info" \
    --header "X-API-KEY:: {api_key}" \
    --header "X-SIGNATURE:: {hmac_signature}" \
    --header "X-TIMESTAMP:: {timestamp}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "first_name=architecto"\
    --form "last_name=architecto"\
    --form "phone=ngzmiyvdljnikhwa"\
    --form "address=architecto"\
    --form "image=@/tmp/phpmbhlNw"

Feedback

POST

https://api.brevix.global

/v1/add-feedback

Feedback for the authenticated user

Expected request fields:

feedback(required)
image(optional)

Headers

X-API-KEY:

Example:

{api_key}

X-SIGNATURE:

Example:

{hmac_signature}

X-TIMESTAMP:

Example:

{timestamp}

Content-Type

Example:

multipart/form-data

Example:

application/json

Body Parameters

feedback

string

required

Must not be greater than 250 characters.

Example:

image

file

Must be an image. Must not be greater than 2048 kilobytes.

Example:

/tmp/phpf5ZRaA

Headers

Body

Received response

Example request:

curl --request POST \
    "https://api.brevix.global/v1/add-feedback" \
    --header "X-API-KEY:: {api_key}" \
    --header "X-SIGNATURE:: {hmac_signature}" \
    --header "X-TIMESTAMP:: {timestamp}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "feedback=b"\
    --form "image=@/tmp/phpf5ZRaA"

Password Update

POST

https://api.brevix.global

/v1/update-password

Update Password for the authenticated user

Expected request fields:

old_password (required)
password (required(Abc@123))
confirm_password (required(Abc@123))

Headers

X-API-KEY:

Example:

{api_key}

X-SIGNATURE:

Example:

{hmac_signature}

X-TIMESTAMP:

Example:

{timestamp}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

old_password

string

required

Example:

architecto

password

string

required

Example:

architecto

confirm_password

string

required

The value and password must match.

Example:

architecto

Headers

Body

{ "old_password": "architecto", "password": "architecto", "confirm_password": "architecto" }

Received response

Example request:

curl --request POST \
    "https://api.brevix.global/v1/update-password" \
    --header "X-API-KEY:: {api_key}" \
    --header "X-SIGNATURE:: {hmac_signature}" \
    --header "X-TIMESTAMP:: {timestamp}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"old_password\": \"architecto\",
    \"password\": \"architecto\",
    \"confirm_password\": \"architecto\"
}"

Remove Account

POST

https://api.brevix.global

/v1/remove-account

Remove Account for the authenticated user

Expected request fields:

reason(required)

Headers

X-API-KEY:

Example:

{api_key}

X-SIGNATURE:

Example:

{hmac_signature}

X-TIMESTAMP:

Example:

{timestamp}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

reason

string

required

Must not be greater than 250 characters.

Example:

Headers

Body

{ "reason": "b" }

Received response

Example request:

curl --request POST \
    "https://api.brevix.global/v1/remove-account" \
    --header "X-API-KEY:: {api_key}" \
    --header "X-SIGNATURE:: {hmac_signature}" \
    --header "X-TIMESTAMP:: {timestamp}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"reason\": \"b\"
}"

Barcode

Retrieve Barcode

GET

https://api.brevix.global

/v1/barcode

Retrieve barcode belonging to the authenticated API key's user

Headers

X-API-KEY:

Example:

{api_key}

Content-Type

Example:

application/json

Example:

application/json

Headers

Received response

Example request:

curl --request GET \
    --get "https://api.brevix.global/v1/barcode" \
    --header "X-API-KEY:: {api_key}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 55
vary: Origin

{
    "error": "API key missing"
}

Generate Barcode

POST

https://api.brevix.global

/v1/generate-barcode

Generate a new Barcode for the authenticated user

Expected request fields:

url (required)
description (optional)
size (optional)
color (optional (hex(like : #000)))
text (optional)
text_size (optional)
text_color (optional (hex(like : #000)))
text_position (optional)
color (optional (hex(like : #000)))

Headers

X-API-KEY:

Example:

{api_key}

X-SIGNATURE:

Example:

{hmac_signature}

X-TIMESTAMP:

Example:

{timestamp}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

url

string

required

Must be a valid URL.

Example:

http://www.bailey.biz/quos-velit-et-fugiat-sunt-nihil-accusantium-harum.html

size

number

Must be at least 10. Must not be greater than 300.

Example:

color

string

Must match the regex /^#([A-Fa-f0-9]{6}.

Example:

#(922815

text

string

Must not be greater than 50 characters.

Example:

text_position

string

Must be one of:

top
bottom

Example:

bottom

text_color

string

Must match the regex /^#([A-Fa-f0-9]{6}.

Example:

#(922815

text_size

number

Must be at least 10. Must not be greater than 80.

Example:

description

string

Must not be greater than 255 characters.

Example:

Harum mollitia modi deserunt aut ab provident perspiciatis quo.

Headers

Body

{ "url": "http:\/\/www.bailey.biz\/quos-velit-et-fugiat-sunt-nihil-accusantium-harum.html", "size": 5, "color": "#(922815", "text": "l", "text_position": "bottom", "text_color": "#(922815", "text_size": 5, "description": "Harum mollitia modi deserunt aut ab provident perspiciatis quo." }

Received response

Example request:

curl --request POST \
    "https://api.brevix.global/v1/generate-barcode" \
    --header "X-API-KEY:: {api_key}" \
    --header "X-SIGNATURE:: {hmac_signature}" \
    --header "X-TIMESTAMP:: {timestamp}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"url\": \"http:\\/\\/www.bailey.biz\\/quos-velit-et-fugiat-sunt-nihil-accusantium-harum.html\",
    \"size\": 5,
    \"color\": \"#(922815\",
    \"text\": \"l\",
    \"text_position\": \"bottom\",
    \"text_color\": \"#(922815\",
    \"text_size\": 5,
    \"description\": \"Harum mollitia modi deserunt aut ab provident perspiciatis quo.\"
}"

Remove Barcode

POST

https://api.brevix.global

/v1/remove-barcode

Remove Barcode belonging to the authenticated API key's user

Expected request fields:
- uuid (required)

Headers

X-API-KEY:

Example:

{api_key}

X-SIGNATURE:

Example:

{hmac_signature}

X-TIMESTAMP:

Example:

{timestamp}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

uuid

string

required

Example:

architecto

Headers

Body

{ "uuid": "architecto" }

Received response

Example request:

curl --request POST \
    "https://api.brevix.global/v1/remove-barcode" \
    --header "X-API-KEY:: {api_key}" \
    --header "X-SIGNATURE:: {hmac_signature}" \
    --header "X-TIMESTAMP:: {timestamp}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"uuid\": \"architecto\"
}"

Update Barcode

POST

https://api.brevix.global

/v1/edit-barcode

Update Barcode belonging to the authenticated API key's user

Expected request fields:

uuid (required)
url (required)
description (optional)
size (optional)
color (optional (hex(like : #000)))
text (optional)
text_size (optional)
text_color (optional (hex(like : #000)))
text_position (optional)
color (optional (hex(like : #000)))

Headers

X-API-KEY:

Example:

{api_key}

X-SIGNATURE:

Example:

{hmac_signature}

X-TIMESTAMP:

Example:

{timestamp}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

uuid

string

required

Example:

architecto

url

string

Must be a valid URL.

Example:

http://bailey.com/

size

number

Must be at least 10. Must not be greater than 300.

Example:

color

string

Must match the regex /^#([A-Fa-f0-9]{6}.

Example:

#(922815

text

string

Must not be greater than 50 characters.

Example:

text_position

string

Must be one of:

top
bottom

Example:

bottom

text_color

string

Must match the regex /^#([A-Fa-f0-9]{6}.

Example:

#(922815

text_size

number

Must be at least 10. Must not be greater than 80.

Example:

description

string

Must not be greater than 255 characters.

Example:

Harum mollitia modi deserunt aut ab provident perspiciatis quo.

Headers

Body

{ "uuid": "architecto", "url": "http:\/\/bailey.com\/", "size": 17, "color": "#(922815", "text": "l", "text_position": "bottom", "text_color": "#(922815", "text_size": 5, "description": "Harum mollitia modi deserunt aut ab provident perspiciatis quo." }

Received response

Example request:

curl --request POST \
    "https://api.brevix.global/v1/edit-barcode" \
    --header "X-API-KEY:: {api_key}" \
    --header "X-SIGNATURE:: {hmac_signature}" \
    --header "X-TIMESTAMP:: {timestamp}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"uuid\": \"architecto\",
    \"url\": \"http:\\/\\/bailey.com\\/\",
    \"size\": 17,
    \"color\": \"#(922815\",
    \"text\": \"l\",
    \"text_position\": \"bottom\",
    \"text_color\": \"#(922815\",
    \"text_size\": 5,
    \"description\": \"Harum mollitia modi deserunt aut ab provident perspiciatis quo.\"
}"

Custom Pages

Retrieve Pages

GET

https://api.brevix.global

/v1/pages

Retrieve Pages belonging to the authenticated API key's user

Headers

X-API-KEY:

Example:

{api_key}

Content-Type

Example:

application/json

Example:

application/json

Headers

Received response

Example request:

curl --request GET \
    --get "https://api.brevix.global/v1/pages" \
    --header "X-API-KEY:: {api_key}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 52
vary: Origin

{
    "error": "API key missing"
}

Remove Pages

POST

https://api.brevix.global

/v1/remove-page

Remove Pages belonging to the authenticated API key's user

Expected request fields:
- uuid (required)

Headers

X-API-KEY:

Example:

{api_key}

X-SIGNATURE:

Example:

{hmac_signature}

X-TIMESTAMP:

Example:

{timestamp}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

uuid

string

required

Example:

architecto

Headers

Body

{ "uuid": "architecto" }

Received response

Example request:

curl --request POST \
    "https://api.brevix.global/v1/remove-page" \
    --header "X-API-KEY:: {api_key}" \
    --header "X-SIGNATURE:: {hmac_signature}" \
    --header "X-TIMESTAMP:: {timestamp}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"uuid\": \"architecto\"
}"

Generate Pages

POST

https://api.brevix.global

/v1/generate-page

Create a custom page for the authenticated user. This API stores frame configuration, generates a shareable page, creates a short link, and generates a QR code.

Expected request fields:

BASIC

title (required, string)
subtitle (optional, string)
slug (required, string) Unique page slug
domain (required, string) Must exist in domains.name

LOGO

logoText (optional, string)
logoStatus (required, 0|1)
logoPosition (required, top-left|top-right|bottom-left|bottom-right)

THEME (object)

theme.bggradient (required, array[2])
theme.bg (optional, string)
theme.logoBg (optional, string)
theme.bodyBg (optional, string)
theme.boxShadow (optional, string)
theme.text (optional, string)
theme.subtext (optional, string)
theme.buttonBg (optional, string)
theme.buttonText (optional, string)
theme.borderWidth (optional, string)
theme.borderColor (optional, string)
theme.borderRadius (optional, string)
theme.socialColor (optional, string)

TOP SHAPE (object)

topShape.color (optional, string)
topShape.height (optional, integer)
topShape.clip (optional, string)

SOCIAL

socialAlign (optional, left|center|right)
socialIcons (optional, array)
socialIcons[].icon (required, string)
socialIcons[].link (optional, URL)
socialIcons[].bg (optional, string)

IMAGES (array)

images[].id (required, integer)
images[].src (required, URL)
images[].status (required, 0|1)
images[].title (optional, string)

BUTTONS (array)

buttons[].id (required, integer)
buttons[].status (required, 0|1)
buttons[].label (required, string)
buttons[].url (optional, URL)

Headers

X-API-KEY:

Example:

{api_key}

X-SIGNATURE:

Example:

{hmac_signature}

X-TIMESTAMP:

Example:

{timestamp}

Content-Type

Example:

multipart/form-data

Example:

application/json

Body Parameters

title

string

required

BASIC. Must not be greater than 255 characters.

Example:

subtext

string

Must not be greater than 500 characters.

Example:

slug

string

required

Must not be greater than 255 characters.

Example:

domain

string

logoText

string

LOGO. Must not be greater than 50 characters.

Example:

logoPosition

string

required

Must be one of:

top-left
top-right
top-center
bottom-left
bottom-right

Example:

top-right

logo

file

Must be an image. Must not be greater than 2048 kilobytes.

Example:

/tmp/phpR3OBcU

socialAlign

string

SOCIAL.

Must be one of:

left
center
right

Example:

right

socialIcons

object[]

images

file[]

required

Must be an image. Must not be greater than 2048 kilobytes.

Example:

buttons

object[]

required

BUTTONS. Must have at least 1 items.

theme

object[]

bgColor

string

THEME 'theme' => 'required|array',.

Example:

architecto

textColor

string

Example:

architecto

subTextColor

string

Example:

architecto

buttonBgColor

string

Example:

architecto

buttonTextColor

string

Example:

architecto

logoBgColor

string

Example:

architecto

borderWidth

string

Example:

architecto

borderColor

string

Example:

architecto

borderRadius

string

Example:

architecto

boxShadow

string

Example:

architecto

socialIconColor

string

Example:

architecto

Headers

Body

Received response

Example request:

curl --request POST \
    "https://api.brevix.global/v1/generate-page" \
    --header "X-API-KEY:: {api_key}" \
    --header "X-SIGNATURE:: {hmac_signature}" \
    --header "X-TIMESTAMP:: {timestamp}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "title=b"\
    --form "subtext=n"\
    --form "slug=g"\
    --form "logoText=z"\
    --form "logoPosition=top-right"\
    --form "socialAlign=right"\
    --form "buttons[][label]=n"\
    --form "buttons[][url]=http://crooks.biz/et-fugiat-sunt-nihil-accusantium"\
    --form "theme[][bgColor]=architecto"\
    --form "theme[][textColor]=architecto"\
    --form "theme[][subTextColor]=architecto"\
    --form "theme[][buttonBgColor]=architecto"\
    --form "theme[][buttonTextColor]=architecto"\
    --form "theme[][logoBgColor]=architecto"\
    --form "theme[][borderWidth]=architecto"\
    --form "theme[][borderColor]=architecto"\
    --form "theme[][borderRadius]=architecto"\
    --form "theme[][boxShadow]=architecto"\
    --form "theme[][socialIconColor]=architecto"\
    --form "socialIcons[][name]=facebook"\
    --form "socialIcons[][link]=http://bailey.com/"\
    --form "socialIcons[][bg]=architecto"\
    --form "logo=@/tmp/phpR3OBcU" \
    --form "images[]=@/tmp/phpx94kq0"

$client = new \GuzzleHttp\Client();
$url = 'https://api.brevix.global/v1/generate-page';
$response = $client->post(
    $url,
    [
        'headers' => [
            'X-API-KEY:' => '{api_key}',
            'X-SIGNATURE:' => '{hmac_signature}',
            'X-TIMESTAMP:' => '{timestamp}',
            'Content-Type' => 'multipart/form-data',
            'Accept' => 'application/json',
        ],
        'multipart' => [
            [
                'name' => 'title',
                'contents' => 'b'
            ],
            [
                'name' => 'subtext',
                'contents' => 'n'
            ],
            [
                'name' => 'slug',
                'contents' => 'g'
            ],
            [
                'name' => 'logoText',
                'contents' => 'z'
            ],
            [
                'name' => 'logoPosition',
                'contents' => 'top-right'
            ],
            [
                'name' => 'socialAlign',
                'contents' => 'right'
            ],
            [
                'name' => 'buttons[][label]',
                'contents' => 'n'
            ],
            [
                'name' => 'buttons[][url]',
                'contents' => 'http://crooks.biz/et-fugiat-sunt-nihil-accusantium'
            ],
            [
                'name' => 'theme[][bgColor]',
                'contents' => 'architecto'
            ],
            [
                'name' => 'theme[][textColor]',
                'contents' => 'architecto'
            ],
            [
                'name' => 'theme[][subTextColor]',
                'contents' => 'architecto'
            ],
            [
                'name' => 'theme[][buttonBgColor]',
                'contents' => 'architecto'
            ],
            [
                'name' => 'theme[][buttonTextColor]',
                'contents' => 'architecto'
            ],
            [
                'name' => 'theme[][logoBgColor]',
                'contents' => 'architecto'
            ],
            [
                'name' => 'theme[][borderWidth]',
                'contents' => 'architecto'
            ],
            [
                'name' => 'theme[][borderColor]',
                'contents' => 'architecto'
            ],
            [
                'name' => 'theme[][borderRadius]',
                'contents' => 'architecto'
            ],
            [
                'name' => 'theme[][boxShadow]',
                'contents' => 'architecto'
            ],
            [
                'name' => 'theme[][socialIconColor]',
                'contents' => 'architecto'
            ],
            [
                'name' => 'socialIcons[][name]',
                'contents' => 'facebook'
            ],
            [
                'name' => 'socialIcons[][link]',
                'contents' => 'http://bailey.com/'
            ],
            [
                'name' => 'socialIcons[][bg]',
                'contents' => 'architecto'
            ],
            [
                'name' => 'logo',
                'contents' => fopen('/tmp/phpR3OBcU', 'r')
            ],
            [
                'name' => 'images[]',
                'contents' => fopen('/tmp/phpx94kq0', 'r')
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://api.brevix.global/v1/generate-page'
files = {
  'title': (None, 'b'),
  'subtext': (None, 'n'),
  'slug': (None, 'g'),
  'logoText': (None, 'z'),
  'logoPosition': (None, 'top-right'),
  'socialAlign': (None, 'right'),
  'buttons[][label]': (None, 'n'),
  'buttons[][url]': (None, 'http://crooks.biz/et-fugiat-sunt-nihil-accusantium'),
  'theme[][bgColor]': (None, 'architecto'),
  'theme[][textColor]': (None, 'architecto'),
  'theme[][subTextColor]': (None, 'architecto'),
  'theme[][buttonBgColor]': (None, 'architecto'),
  'theme[][buttonTextColor]': (None, 'architecto'),
  'theme[][logoBgColor]': (None, 'architecto'),
  'theme[][borderWidth]': (None, 'architecto'),
  'theme[][borderColor]': (None, 'architecto'),
  'theme[][borderRadius]': (None, 'architecto'),
  'theme[][boxShadow]': (None, 'architecto'),
  'theme[][socialIconColor]': (None, 'architecto'),
  'socialIcons[][name]': (None, 'facebook'),
  'socialIcons[][link]': (None, 'http://bailey.com/'),
  'socialIcons[][bg]': (None, 'architecto'),
  'logo': open('/tmp/phpR3OBcU', 'rb'),
  'images[]': open('/tmp/phpx94kq0', 'rb')}
payload = {
    "title": "b",
    "subtext": "n",
    "slug": "g",
    "logoText": "z",
    "logoPosition": "top-right",
    "socialAlign": "right",
    "buttons": [
        {
            "label": "n",
            "url": "http:\/\/crooks.biz\/et-fugiat-sunt-nihil-accusantium"
        }
    ],
    "theme": [
        {
            "bgColor": "architecto",
            "textColor": "architecto",
            "subTextColor": "architecto",
            "buttonBgColor": "architecto",
            "buttonTextColor": "architecto",
            "logoBgColor": "architecto",
            "borderWidth": "architecto",
            "borderColor": "architecto",
            "borderRadius": "architecto",
            "boxShadow": "architecto",
            "socialIconColor": "architecto"
        }
    ],
    "socialIcons": [
        {
            "name": "facebook",
            "link": "http:\/\/bailey.com\/",
            "bg": "architecto"
        }
    ]
}
headers = {
  'X-API-KEY:': '{api_key}',
  'X-SIGNATURE:': '{hmac_signature}',
  'X-TIMESTAMP:': '{timestamp}',
  'Content-Type': 'multipart/form-data',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers, files=files)
response.json()

Update Pages

POST

https://api.brevix.global

/v1/edit-page

Update pages belonging to the authenticated API key's user

Expected request fields:

BASIC

uuid (required)
title (required, string)
subtitle (optional, string)
slug (required, string) Unique page slug
domain (required, string) Must exist in domains.name

LOGO

logoText (optional, string)
logoStatus (required, 0|1)
logoPosition (required, top-left|top-right|bottom-left|bottom-right)

THEME (object)

theme.bggradient (required, array[2])
theme.bg (optional, string)
theme.logoBg (optional, string)
theme.bodyBg (optional, string)
theme.boxShadow (optional, string)
theme.text (optional, string)
theme.subtext (optional, string)
theme.buttonBg (optional, string)
theme.buttonText (optional, string)
theme.borderWidth (optional, string)
theme.borderColor (optional, string)
theme.borderRadius (optional, string)
theme.socialColor (optional, string)

TOP SHAPE (object)

topShape.color (optional, string)
topShape.height (optional, integer)
topShape.clip (optional, string)

SOCIAL

socialAlign (optional, left|center|right)
socialIcons (optional, array)
socialIcons[].icon (required, string)
socialIcons[].link (optional, URL)
socialIcons[].bg (optional, string)

IMAGES (array)

images[].id (required, integer)
images[].src (required, URL)
images[].status (required, 0|1)
images[].title (optional, string)

BUTTONS (array)

buttons[].id (required, integer)
buttons[].status (required, 0|1)
buttons[].label (required, string)
buttons[].url (optional, URL)

Headers

X-API-KEY:

Example:

{api_key}

X-SIGNATURE:

Example:

{hmac_signature}

X-TIMESTAMP:

Example:

{timestamp}

Content-Type

Example:

multipart/form-data

Example:

application/json

Body Parameters

uuid

string

required

BASIC.

Example:

architecto

title

string

required

Must not be greater than 255 characters.

Example:

subtext

string

Must not be greater than 500 characters.

Example:

logo

file

LOGO. Must be an image. Must not be greater than 2048 kilobytes.

Example:

/tmp/phpCo0cxo

logoText

string

Must not be greater than 50 characters.

Example:

logoPosition

string

required

Must be one of:

top-left
top-right
top-center
bottom-left
bottom-right

Example:

top-center

theme

object[]

THEME.

bgColor

string

Example:

architecto

textColor

string

Example:

architecto

subTextColor

string

Example:

architecto

buttonBgColor

string

Example:

architecto

buttonTextColor

string

Example:

architecto

logoBgColor

string

Example:

architecto

borderWidth

string

Example:

architecto

borderColor

string

Example:

architecto

borderRadius

string

Example:

architecto

boxShadow

string

Example:

architecto

socialIconColor

string

Example:

architecto

socialAlign

string

SOCIAL.

Must be one of:

left
center
right

Example:

left

socialIcons

object[]

images

file[]

Must be an image. Must not be greater than 2048 kilobytes.

Example:

buttons

object[]

required

BUTTONS. Must have at least 1 items.

Headers

Body

Received response

Example request:

curl --request POST \
    "https://api.brevix.global/v1/edit-page" \
    --header "X-API-KEY:: {api_key}" \
    --header "X-SIGNATURE:: {hmac_signature}" \
    --header "X-TIMESTAMP:: {timestamp}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "uuid=architecto"\
    --form "title=n"\
    --form "subtext=g"\
    --form "logoText=z"\
    --form "logoPosition=top-center"\
    --form "socialAlign=left"\
    --form "buttons[][label]=n"\
    --form "buttons[][url]=http://crooks.biz/et-fugiat-sunt-nihil-accusantium"\
    --form "theme[][bgColor]=architecto"\
    --form "theme[][textColor]=architecto"\
    --form "theme[][subTextColor]=architecto"\
    --form "theme[][buttonBgColor]=architecto"\
    --form "theme[][buttonTextColor]=architecto"\
    --form "theme[][logoBgColor]=architecto"\
    --form "theme[][borderWidth]=architecto"\
    --form "theme[][borderColor]=architecto"\
    --form "theme[][borderRadius]=architecto"\
    --form "theme[][boxShadow]=architecto"\
    --form "theme[][socialIconColor]=architecto"\
    --form "socialIcons[][name]=facebook"\
    --form "socialIcons[][link]=http://bailey.com/"\
    --form "socialIcons[][bg]=architecto"\
    --form "logo=@/tmp/phpCo0cxo" \
    --form "images[]=@/tmp/phpJxAcCC"

$client = new \GuzzleHttp\Client();
$url = 'https://api.brevix.global/v1/edit-page';
$response = $client->post(
    $url,
    [
        'headers' => [
            'X-API-KEY:' => '{api_key}',
            'X-SIGNATURE:' => '{hmac_signature}',
            'X-TIMESTAMP:' => '{timestamp}',
            'Content-Type' => 'multipart/form-data',
            'Accept' => 'application/json',
        ],
        'multipart' => [
            [
                'name' => 'uuid',
                'contents' => 'architecto'
            ],
            [
                'name' => 'title',
                'contents' => 'n'
            ],
            [
                'name' => 'subtext',
                'contents' => 'g'
            ],
            [
                'name' => 'logoText',
                'contents' => 'z'
            ],
            [
                'name' => 'logoPosition',
                'contents' => 'top-center'
            ],
            [
                'name' => 'socialAlign',
                'contents' => 'left'
            ],
            [
                'name' => 'buttons[][label]',
                'contents' => 'n'
            ],
            [
                'name' => 'buttons[][url]',
                'contents' => 'http://crooks.biz/et-fugiat-sunt-nihil-accusantium'
            ],
            [
                'name' => 'theme[][bgColor]',
                'contents' => 'architecto'
            ],
            [
                'name' => 'theme[][textColor]',
                'contents' => 'architecto'
            ],
            [
                'name' => 'theme[][subTextColor]',
                'contents' => 'architecto'
            ],
            [
                'name' => 'theme[][buttonBgColor]',
                'contents' => 'architecto'
            ],
            [
                'name' => 'theme[][buttonTextColor]',
                'contents' => 'architecto'
            ],
            [
                'name' => 'theme[][logoBgColor]',
                'contents' => 'architecto'
            ],
            [
                'name' => 'theme[][borderWidth]',
                'contents' => 'architecto'
            ],
            [
                'name' => 'theme[][borderColor]',
                'contents' => 'architecto'
            ],
            [
                'name' => 'theme[][borderRadius]',
                'contents' => 'architecto'
            ],
            [
                'name' => 'theme[][boxShadow]',
                'contents' => 'architecto'
            ],
            [
                'name' => 'theme[][socialIconColor]',
                'contents' => 'architecto'
            ],
            [
                'name' => 'socialIcons[][name]',
                'contents' => 'facebook'
            ],
            [
                'name' => 'socialIcons[][link]',
                'contents' => 'http://bailey.com/'
            ],
            [
                'name' => 'socialIcons[][bg]',
                'contents' => 'architecto'
            ],
            [
                'name' => 'logo',
                'contents' => fopen('/tmp/phpCo0cxo', 'r')
            ],
            [
                'name' => 'images[]',
                'contents' => fopen('/tmp/phpJxAcCC', 'r')
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://api.brevix.global/v1/edit-page'
files = {
  'uuid': (None, 'architecto'),
  'title': (None, 'n'),
  'subtext': (None, 'g'),
  'logoText': (None, 'z'),
  'logoPosition': (None, 'top-center'),
  'socialAlign': (None, 'left'),
  'buttons[][label]': (None, 'n'),
  'buttons[][url]': (None, 'http://crooks.biz/et-fugiat-sunt-nihil-accusantium'),
  'theme[][bgColor]': (None, 'architecto'),
  'theme[][textColor]': (None, 'architecto'),
  'theme[][subTextColor]': (None, 'architecto'),
  'theme[][buttonBgColor]': (None, 'architecto'),
  'theme[][buttonTextColor]': (None, 'architecto'),
  'theme[][logoBgColor]': (None, 'architecto'),
  'theme[][borderWidth]': (None, 'architecto'),
  'theme[][borderColor]': (None, 'architecto'),
  'theme[][borderRadius]': (None, 'architecto'),
  'theme[][boxShadow]': (None, 'architecto'),
  'theme[][socialIconColor]': (None, 'architecto'),
  'socialIcons[][name]': (None, 'facebook'),
  'socialIcons[][link]': (None, 'http://bailey.com/'),
  'socialIcons[][bg]': (None, 'architecto'),
  'logo': open('/tmp/phpCo0cxo', 'rb'),
  'images[]': open('/tmp/phpJxAcCC', 'rb')}
payload = {
    "uuid": "architecto",
    "title": "n",
    "subtext": "g",
    "logoText": "z",
    "logoPosition": "top-center",
    "socialAlign": "left",
    "buttons": [
        {
            "label": "n",
            "url": "http:\/\/crooks.biz\/et-fugiat-sunt-nihil-accusantium"
        }
    ],
    "theme": [
        {
            "bgColor": "architecto",
            "textColor": "architecto",
            "subTextColor": "architecto",
            "buttonBgColor": "architecto",
            "buttonTextColor": "architecto",
            "logoBgColor": "architecto",
            "borderWidth": "architecto",
            "borderColor": "architecto",
            "borderRadius": "architecto",
            "boxShadow": "architecto",
            "socialIconColor": "architecto"
        }
    ],
    "socialIcons": [
        {
            "name": "facebook",
            "link": "http:\/\/bailey.com\/",
            "bg": "architecto"
        }
    ]
}
headers = {
  'X-API-KEY:': '{api_key}',
  'X-SIGNATURE:': '{hmac_signature}',
  'X-TIMESTAMP:': '{timestamp}',
  'Content-Type': 'multipart/form-data',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers, files=files)
response.json()

Health

Health check

GET

https://api.brevix.global

/v1/healthcheck

Returns a simple JSON payload confirming the system is operational.

Headers

Content-Type

Example:

application/json

Example:

application/json

Headers

Received response

Example request:

curl --request GET \
    --get "https://api.brevix.global/v1/healthcheck" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 59
vary: Origin

{
    "status": "success",
    "message": "System is healthy and operational."
}

Links

Retrieve links

GET

https://api.brevix.global

/v1/links

Retrieve links belonging to the authenticated API key's user

Headers

X-API-KEY:

Example:

{api_key}

Content-Type

Example:

application/json

Example:

application/json

Headers

Received response

Example request:

curl --request GET \
    --get "https://api.brevix.global/v1/links" \
    --header "X-API-KEY:: {api_key}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 58
vary: Origin

{
    "error": "API key missing"
}

Generate link

POST

https://api.brevix.global

/v1/generate-link

Generate a new shortened link for the authenticated user

Expected request fields:

link (required, URL)
description (optional)
tag (optional)
expire (optional, date)
customLink (optional, custom short code)

Headers

X-API-KEY:

Example:

{api_key}

X-SIGNATURE:

Example:

{hmac_signature}

X-TIMESTAMP:

Example:

{timestamp}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

link

string

required

Must be a valid URL.

Example:

http://www.bailey.biz/quos-velit-et-fugiat-sunt-nihil-accusantium-harum.html

Headers

Body

{ "link": "http:\/\/www.bailey.biz\/quos-velit-et-fugiat-sunt-nihil-accusantium-harum.html" }

Received response

Example request:

curl --request POST \
    "https://api.brevix.global/v1/generate-link" \
    --header "X-API-KEY:: {api_key}" \
    --header "X-SIGNATURE:: {hmac_signature}" \
    --header "X-TIMESTAMP:: {timestamp}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"link\": \"http:\\/\\/www.bailey.biz\\/quos-velit-et-fugiat-sunt-nihil-accusantium-harum.html\"
}"

Remove links

POST

https://api.brevix.global

/v1/remove-links

Remove links belonging to the authenticated API key's user

Expected request fields:
- uuid (required)

Headers

X-API-KEY:

Example:

{api_key}

X-SIGNATURE:

Example:

{hmac_signature}

X-TIMESTAMP:

Example:

{timestamp}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

uuid

string

required

Example:

architecto

Headers

Body

{ "uuid": "architecto" }

Received response

Example request:

curl --request POST \
    "https://api.brevix.global/v1/remove-links" \
    --header "X-API-KEY:: {api_key}" \
    --header "X-SIGNATURE:: {hmac_signature}" \
    --header "X-TIMESTAMP:: {timestamp}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"uuid\": \"architecto\"
}"

Update links

POST

https://api.brevix.global

/v1/edit-links

Update links belonging to the authenticated API key's user

Expected request fields:

uuid (required)
link (required, URL)
description (optional)
tag (optional)
expire (optional, date)
customLink (optional, custom short code)

Headers

X-API-KEY:

Example:

{api_key}

X-SIGNATURE:

Example:

{hmac_signature}

X-TIMESTAMP:

Example:

{timestamp}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

uuid

string

required

Example:

architecto

link

string

required

Example:

architecto

Headers

Body

{ "uuid": "architecto", "link": "architecto" }

Received response

Example request:

curl --request POST \
    "https://api.brevix.global/v1/edit-links" \
    --header "X-API-KEY:: {api_key}" \
    --header "X-SIGNATURE:: {hmac_signature}" \
    --header "X-TIMESTAMP:: {timestamp}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"uuid\": \"architecto\",
    \"link\": \"architecto\"
}"

QR Code

Retrieve QR Code

GET

https://api.brevix.global

/v1/qrcode

Retrieve QR Code belonging to the authenticated API key's user

Headers

X-API-KEY:

Example:

{api_key}

Content-Type

Example:

application/json

Example:

application/json

Headers

Received response

Example request:

curl --request GET \
    --get "https://api.brevix.global/v1/qrcode" \
    --header "X-API-KEY:: {api_key}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 56
vary: Origin

{
    "error": "API key missing"
}

Generate QR Code

POST

https://api.brevix.global

/v1/generate-qr

Generate a new QR Code for the authenticated user

Expected request fields:

url (required)
description (optional)
size (optional)
color (optional (hex(like : #000)))
eye_color (optional(hex(like : #000)))
pattern (required(squares,dots))
logo (optional(type:jpeg,png,jpg,size:2mb))

Headers

X-API-KEY:

Example:

{api_key}

X-SIGNATURE:

Example:

{hmac_signature}

X-TIMESTAMP:

Example:

{timestamp}

Content-Type

Example:

multipart/form-data

Example:

application/json

Body Parameters

url

string

required

Must be a valid URL.

Example:

http://www.bailey.biz/quos-velit-et-fugiat-sunt-nihil-accusantium-harum.html

color

string

Must match the regex /^#([A-Fa-f0-9]{6}.

Example:

#(922815

eye_color

string

Must match the regex /^#([A-Fa-f0-9]{6}.

Example:

#(922815

pattern

string

required

Must be one of:

squares
dots

Example:

squares

size

integer

Must be at least 200. Must not be greater than 500.

Example:

logo

file

Must be an image. Must not be greater than 2048 kilobytes.

Example:

/tmp/php7eQyNc

Headers

Body

Received response

Example request:

curl --request POST \
    "https://api.brevix.global/v1/generate-qr" \
    --header "X-API-KEY:: {api_key}" \
    --header "X-SIGNATURE:: {hmac_signature}" \
    --header "X-TIMESTAMP:: {timestamp}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "url=http://www.bailey.biz/quos-velit-et-fugiat-sunt-nihil-accusantium-harum.html"\
    --form "color=#(922815"\
    --form "eye_color=#(922815"\
    --form "pattern=squares"\
    --form "size=5"\
    --form "logo=@/tmp/php7eQyNc"

Remove QR Code

POST

https://api.brevix.global

/v1/remove-qr

Remove QR Code belonging to the authenticated API key's user

Expected request fields:
- uuid (required)

Headers

X-API-KEY:

Example:

{api_key}

X-SIGNATURE:

Example:

{hmac_signature}

X-TIMESTAMP:

Example:

{timestamp}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

uuid

string

required

Example:

architecto

Headers

Body

{ "uuid": "architecto" }

Received response

Example request:

curl --request POST \
    "https://api.brevix.global/v1/remove-qr" \
    --header "X-API-KEY:: {api_key}" \
    --header "X-SIGNATURE:: {hmac_signature}" \
    --header "X-TIMESTAMP:: {timestamp}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"uuid\": \"architecto\"
}"

Update QR Code

POST

https://api.brevix.global

/v1/edit-qr

Update Qr Code belonging to the authenticated API key's user

Expected request fields:

uuid (required)
url (required)
description (optional)
size (optional)
color (optional (hex(like : #000)))
eye_color (optional(hex(like : #000)))
pattern (required(squares,dots))
logo (optional(type:jpeg,png,jpg,size:2mb))

Headers

X-API-KEY:

Example:

{api_key}

X-SIGNATURE:

Example:

{hmac_signature}

X-TIMESTAMP:

Example:

{timestamp}

Content-Type

Example:

multipart/form-data

Example:

application/json

Body Parameters

uuid

string

required

Example:

architecto

url

string

Must be a valid URL.

Example:

http://bailey.com/

color

string

Must match the regex /^#([A-Fa-f0-9]{6}.

Example:

#(922815

eye_color

string

Must match the regex /^#([A-Fa-f0-9]{6}.

Example:

#(922815

pattern

string

Must be one of:

squares
dots

Example:

dots

size

integer

Must be at least 200. Must not be greater than 500.

Example:

logo

file

Must be an image. Must not be greater than 2048 kilobytes.

Example:

/tmp/phpA32s6T

Headers

Body

Received response

Example request:

curl --request POST \
    "https://api.brevix.global/v1/edit-qr" \
    --header "X-API-KEY:: {api_key}" \
    --header "X-SIGNATURE:: {hmac_signature}" \
    --header "X-TIMESTAMP:: {timestamp}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "uuid=architecto"\
    --form "url=http://bailey.com/"\
    --form "color=#(922815"\
    --form "eye_color=#(922815"\
    --form "pattern=dots"\
    --form "size=5"\
    --form "logo=@/tmp/phpA32s6T"

UTM Builder

Retrieve UTM

GET

https://api.brevix.global

/v1/utm

Retrieve Utm links belonging to the authenticated API key's user

Headers

X-API-KEY:

Example:

{api_key}

Content-Type

Example:

application/json

Example:

application/json

Headers

Received response

Example request:

curl --request GET \
    --get "https://api.brevix.global/v1/utm" \
    --header "X-API-KEY:: {api_key}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 57
vary: Origin

{
    "error": "API key missing"
}

Generate UTM

POST

https://api.brevix.global

/v1/generate-utm

Generate a new UTM link for the authenticated user

Expected request fields:

url (required)
source (required)
medium (required)
campaign (required)
content (required)

Headers

X-API-KEY:

Example:

{api_key}

X-SIGNATURE:

Example:

{hmac_signature}

X-TIMESTAMP:

Example:

{timestamp}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

url

string

required

Must be a valid URL.

Example:

http://www.bailey.biz/quos-velit-et-fugiat-sunt-nihil-accusantium-harum.html

source

string

required

Example:

architecto

medium

string

required

Example:

architecto

campaign

string

required

Example:

architecto

content

string

required

Example:

architecto

Headers

Body

{ "url": "http:\/\/www.bailey.biz\/quos-velit-et-fugiat-sunt-nihil-accusantium-harum.html", "source": "architecto", "medium": "architecto", "campaign": "architecto", "content": "architecto" }

Received response

Example request:

curl --request POST \
    "https://api.brevix.global/v1/generate-utm" \
    --header "X-API-KEY:: {api_key}" \
    --header "X-SIGNATURE:: {hmac_signature}" \
    --header "X-TIMESTAMP:: {timestamp}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"url\": \"http:\\/\\/www.bailey.biz\\/quos-velit-et-fugiat-sunt-nihil-accusantium-harum.html\",
    \"source\": \"architecto\",
    \"medium\": \"architecto\",
    \"campaign\": \"architecto\",
    \"content\": \"architecto\"
}"

Remove UTM

POST

https://api.brevix.global

/v1/remove-utm

Remove UTM belonging to the authenticated API key's user

Expected request fields:
- uuid (required)

Headers

X-API-KEY:

Example:

{api_key}

X-SIGNATURE:

Example:

{hmac_signature}

X-TIMESTAMP:

Example:

{timestamp}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

uuid

string

required

Example:

architecto

Headers

Body

{ "uuid": "architecto" }

Received response

Example request:

curl --request POST \
    "https://api.brevix.global/v1/remove-utm" \
    --header "X-API-KEY:: {api_key}" \
    --header "X-SIGNATURE:: {hmac_signature}" \
    --header "X-TIMESTAMP:: {timestamp}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"uuid\": \"architecto\"
}"

Update UTM

POST

https://api.brevix.global

/v1/edit-utm

Update utm belonging to the authenticated API key's user

Expected request fields:

uuid (required)
url (required)
source (required)
medium (required)
campaign (required)
content (required)

Headers

X-API-KEY:

Example:

{api_key}

X-SIGNATURE:

Example:

{hmac_signature}

X-TIMESTAMP:

Example:

{timestamp}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

uuid

string

required

Example:

architecto

url

string

required

Must be a valid URL.

Example:

http://bailey.com/

source

string

required

Example:

architecto

medium

string

required

Example:

architecto

campaign

string

required

Example:

architecto

content

string

required

Example:

architecto

Headers

Body

{ "uuid": "architecto", "url": "http:\/\/bailey.com\/", "source": "architecto", "medium": "architecto", "campaign": "architecto", "content": "architecto" }

Received response

Example request:

curl --request POST \
    "https://api.brevix.global/v1/edit-utm" \
    --header "X-API-KEY:: {api_key}" \
    --header "X-SIGNATURE:: {hmac_signature}" \
    --header "X-TIMESTAMP:: {timestamp}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"uuid\": \"architecto\",
    \"url\": \"http:\\/\\/bailey.com\\/\",
    \"source\": \"architecto\",
    \"medium\": \"architecto\",
    \"campaign\": \"architecto\",
    \"content\": \"architecto\"
}"