URL

Generate product QR Code

get

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

short_url_idstringRequired

Responses

200Success

application/json

successbooleanOptionalExample: true

messagestringOptionalExample: Request successful

datamultipleOptionalExample: Brand | Product | Notification | ...

get

/url/qr/{short_url_id}

HTTPcURLJavaScriptPython

GET /url/qr/{short_url_id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

{
  "success": true,
  "message": "Request successful",
  "data": "Brand | Product | Notification | ..."
}

Get all URLs for a product

get

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

product_idstringRequired

Responses

200Success

application/json

successbooleanOptionalExample: true

messagestringOptionalExample: Request successful

datamultipleOptionalExample: Brand | Product | Notification | ...

get

/url/product/{product_id}

HTTPcURLJavaScriptPython

GET /url/product/{product_id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

{
  "success": true,
  "message": "Request successful",
  "data": "Brand | Product | Notification | ..."
}

Get all unclaimed URLs with share history for a product

get

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

product_idstringRequired

Responses

200Success

application/json

successbooleanOptionalExample: true

messagestringOptionalExample: Request successful

datamultipleOptionalExample: Brand | Product | Notification | ...

get

/url/product/{product_id}/unclaimed

HTTPcURLJavaScriptPython

GET /url/product/{product_id}/unclaimed HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

{
  "success": true,
  "message": "Request successful",
  "data": "Brand | Product | Notification | ..."
}

Get next available (unclaimed) URL for a product

get

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

product_idstringRequired

Query parameters

exclude_sharedstringRequired

Responses

200Success

application/json

successbooleanOptionalExample: true

messagestringOptionalExample: Request successful

datamultipleOptionalExample: Brand | Product | Notification | ...

get

/url/product/{product_id}/next-available

HTTPcURLJavaScriptPython

GET /url/product/{product_id}/next-available?exclude_shared=text HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

{
  "success": true,
  "message": "Request successful",
  "data": "Brand | Product | Notification | ..."
}

Share QR code via email

post

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200Success

application/json

successbooleanOptionalExample: true

messagestringOptionalExample: Request successful

datamultipleOptionalExample: Brand | Product | Notification | ...

201Success

post

/url/share

HTTPcURLJavaScriptPython

POST /url/share HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "success": true,
  "message": "Request successful",
  "data": "Brand | Product | Notification | ..."
}