Query |
GET https://qr.ax/api/create-qr/<value>/<watermark>/<shadow>/<theme>:<scale>/<filename> |
Params |
value (str): 5-2953 chars watermark (%-encoded str): 0-23 chars (post-decoding) shadow (bool): "1" or "0" (combine with transparent elements) theme (str): "1bit", "blue", "aqua", "green", "moss", "orange", "red", "lilac", "pink", "custom:<dark>:<data_dark>:<light>:<data_light>:<quiet_zone>" (RGB hex values, "None" for transparent. See example and segno docs for more info) scale (int): 5-30 filename (str): 4-200 chars |
Examples |
GET https://qr.ax/api/create-qr/http://www.example.com/qr.ax%2F%20/0/green:5/qrcode.png GET https://qr.ax/api/create-qr/http://example.com/custom/1/custom:202020:404040:None:None:None:5/pic.png |
Response |
200 OK:
|
400 Bad Request:{
"status" : "fail",
"data" : {
"filename" : "Length not in accepted range (5-200)"
}
} |
400 Bad Request:{
"status" : "fail",
"data" : {
"scale" : "Number not in accepted range (5-30)"
}
} |
400 Bad Request:{
"status" : "fail",
"data" : {
"value" : "Length not in accepted range (5-2953)"
}
} |
400 Bad Request:{
"status" : "fail",
"data" : {
"theme" : "Invalid theme name"
}
} |
400 Bad Request:{
"status" : "fail",
"data" : {
"theme" : "Bad formatting of custom theme - Please refer to documentation"
}
} |
500 Internal Server Error:{
"status" : "error",
"data" : {
"type" : "Internal Server Error"
}
} |
Query |
GET https://qr.ax/api/create-url/<value> |
Params |
value (str): 9-300 chars |
Example |
GET https://qr.ax/api/create-url/https://www.example.com/ |
Response |
201 Created:
{
"status" : "success",
"data" : {
"id" : "2mk3i",
"delete-code" : "f6aTb2tWrZ7U",
"hyperlink" : {
"redirect-url" : "https://qr.ax/2mk3i",
"retrieve-url" : "https://qr.ax/api/fetch-url/2mk3i",
"delete-url" : "https://qr.ax/api/delete-url/2mk3i/f6aTb2tWrZ7U",
"original-url" : "https://www.example.com/"
}
}
} |
400 Bad Request:{
"status" : "fail",
"data" : {
"value" : "Length not in accepted range (9-300)"
}
} |
500 Internal Server Error:{
"status" : "error",
"data" : {
"type" : "Internal Server Error"
}
} |
Query |
GET https://qr.ax/api/delete-url/<id>/<code> |
Params |
id (str): Exactly 5 chars code (str): Exactly 12 chars |
Example |
GET https://qr.ax/api/delete-url/a4a1b/NmeWzlfJFI4M |
Response |
200 OK:
{
"status" : "success",
"data" : {
"id" : "Entry deleted"
}
} |
404 Not Found:{
"status" : "fail",
"data" : {
"id" : "Requested id not found, or wrong code provided"
}
} |
400 Bad Request:{
"status" : "fail",
"data" : {
"id" : "Length not 5"
}
} |
400 Bad Request:{
"status" : "fail",
"data" : {
"code" : "Length not 12"
}
} |
500 Internal Server Error:{
"status" : "error",
"data" : {
"type" : "Internal Server Error"
}
} |
Query |
GET https://qr.ax/api/fetch-url/<id> |
Params |
id (str): Exactly 5 chars |
Example |
GET https://qr.ax/api/fetch-url/73c32 |
Response |
200 OK:
{
"status" : "success",
"data" : {
"id" : "73c32",
"hyperlink" : {
"redirect-url" : "https://qr.ax/73c32",
"retrieve-url" : "https://qr.ax/api/fetch-url/73c32",
"original-url" : "http://www.example.com/"
}
}
} |
404 Not Found:{
"status" : "fail",
"data" : {
"id" : "Requested id not found. Deleted?"
}
} |
400 Bad Request:{
"status" : "fail",
"data" : {
"id" : "Length not 5"
}
} |
500 Internal Server Error:{
"status" : "error",
"data" : {
"type" : "Internal Server Error"
}
} |