Documentation Powered by ReDoc

VIZOR API (2.0.0)

Download OpenAPI specification:Download

E-mail: ziv@redirectsolutions.com

This is the API documentation for the VIZOR demo by Redirect Solutions.



Get Authorization token

  1. A POST call to /user/create to create your user account with us
  2. A POST call to /login to get authorization token

QR Code

The standard flow to create an image with the QR embeded is the following

  1. A POST call to /embeds/create to obtain an embed slug
  2. A POST call to /embeds/update/{slug} to set the embed details
  3. A POST call to /embeds/update-link/{slug} to update the QR link

Security Details

Security standards followed in development

  1. Data encryption(AES-256) - API Limits - Wallet Amount - Ethereum Address
  2. All documents and images are stored in Amazon s3 private bucket. They are only accessible via a token.
  3. APIs are authenticated with JWT token which expires in 7 days.
  4. Website is built upon Laravel v6.2, Blade Template Engine
  5. CSRF protection
  6. Dependency Injection protection
  7. All the requests to the server are HTTPS.

Account Dashboard

Your account dashboard where you can see all your QR images.

Visit Following URL https://website.vizorads.com/
Enter your account credentials like email address and password to login into your account.

Authentication

bearerAuth

Security Scheme Type https

Status

Whether or not the server is ready

Find out status of the API

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": 0,
  • "data": {
    }
}

Authorization

Authenticate Users

Create User

This endpoint require name, email and password in order to create you account with RapidAPI

Request Body schema: application/json
name
string
email
string <email>
password
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "email": "user@example.com",
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": 0
}

Login

This endpoint require email and password in order to provide token

Request Body schema: application/json
email
string <email>
password
string

Responses

Request samples

Content type
application/json
{
  • "email": "user@example.com",
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": 0,
  • "data": {
    }
}

QR

Everything related to the QR generation

Creates a new embed

It just creates an embed with provided body

header Parameters
x-marketplace-id
required
string

Marketplace Id of a user account

Request Body schema: application/json
link
string <url>
name
string
file
string <binary>
description
string
position
string
Enum: "top_left" "top_right" "bottom_left" "bottom_right" "center"
padding
integer >= 0
scaleFactor
integer >= 0

Responses

Request samples

Content type
application/json
{
  • "link": "string",
  • "name": "string",
  • "file": "string",
  • "description": "string",
  • "position": "top_left",
  • "padding": 0,
  • "scaleFactor": 0
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": 0,
  • "data": {
    }
}

Gets an existing embed

path Parameters
slug
required
string

Slug of the embed

header Parameters
x-marketplace-id
required
string

Marketplace Id of a user account

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": 0,
  • "data": {
    }
}

Updates properties of an existing embed

All parameters are optional

path Parameters
slug
required
string

Slug of the embed

header Parameters
x-marketplace-id
required
string

Marketplace Id of a user account

Request Body schema: application/json
link
string <url>
name
string
file
string <binary>
description
string
position
string
Enum: "top_left" "top_right" "bottom_left" "bottom_right" "center"
padding
integer >= 0
scaleFactor
integer >= 0

Responses

Request samples

Content type
application/json
{
  • "link": "string",
  • "name": "string",
  • "file": "string",
  • "description": "string",
  • "position": "top_left",
  • "padding": 0,
  • "scaleFactor": 0
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": 0,
  • "data": {
    }
}

Updates Link of QR code

link parameter is required

path Parameters
slug
required
string

Slug of the embed

header Parameters
x-marketplace-id
required
string

Marketplace Id of a user account

Request Body schema: application/json
link
string <url>

Responses

Request samples

Content type
application/json
{
  • "link": "string"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": 0,
  • "data": {
    }
}