logo
© Quick Code - QR Code Generator

Quick Code Api Docs (2.15.2)

Authorization

The first step to use this API is to authorize your requests.

Obtain an access token

Get the access token using your account email & password, once issued, you must save it in your application to use it in subsequent requests.

Authorizations:
password_grant
Request Body schema: application/json

Login payload

password
string <password> (Password)

Minimum 6 charachters

email
string <email> (Email)

User email address

Responses

Request samples

Content type
application/json
{
  • "email": "admin@example.invalid",
  • "password": "password"
}

Response samples

Content type
application/json
{
  • "token": "772|ayiFNgEqnzhij9QUK3mONbzi4xIv7hhWzCsRZUjZ",
  • "user": {
    }
}

QR Code

This API generates QR code in SVG format, the result QR code svg file can be downloaded from /qrcode_files/[qrcode.file_name].svg it is possible to convert svg to png by utilizing browser canvas.

Create QR code

Authorizations:
password_grant
Request Body schema: application/json
object

Data supplied as QR code content. Fields should be provided in accordance to type attribute. For example if type is url then data.url attribute must be provided. Similarly if type is text then data.text attribute should be provided.

object
name
string

Searchable and meaningful name, e.g. Summer Offer.

type
string
Enum: "URL" "VCard" "Text" "Email" "SMS" "WIFI"

QR Code data type.

Responses

Request samples

Content type
application/json
Example
{
  • "data": {},
  • "type": "url",
  • "design": {
    },
  • "name": "https://google.com"
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "design": {
    },
  • "name": "string",
  • "type": "URL"
}

Update QR code.

Authorizations:
password_grant
path Parameters
qrcode_id
string

The ID of QR code to be modified.

Request Body schema: application/json
object

Data supplied as QR code content. Fields should be provided in accordance to type attribute. For example if type is url then data.url attribute must be provided. Similarly if type is text then data.text attribute should be provided.

object
name
string

Searchable and meaningful name, e.g. Summer Offer.

type
string
Enum: "URL" "VCard" "Text" "Email" "SMS" "WIFI"

QR Code data type.

Responses

Request samples

Content type
application/json
Example
{
  • "data": {},
  • "type": "url",
  • "design": {
    },
  • "name": "https://google.com"
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "design": {
    },
  • "name": "string",
  • "type": "URL"
}

QR Code Redirect

Get QR code redirect.

When a dynamic QR code is created, a redirect record is auto generated and it has the short url in the route attribute.

Authorizations:
password_grant
path Parameters
qrcode_id
string

ID of dynamic QR code.

Responses

Response samples

Content type
application/json
{}