Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 22 additions & 22 deletions documentation.md
Original file line number Diff line number Diff line change
@@ -1,61 +1,61 @@
#QR Code API#
# QR Code API #

##Request##
## Request ##

The API base URL is: `http://api.qrcode.unitag.fr/api`

A QR Code API request is based on these following primary parameters:

##Parameters##
## Parameters ##

###t_pwd (required)
### t_pwd (required)
Provide the authentication for your account.

Values:
- To obtain a token please create an account on Unitag's platform and contact the Unitag Team.
- You can set `degraded` as value for tests (the answer received will be limited to a PNG format image of 200px size).

###T (optional)
### T (optional)
Change the image format received.

Values: `SVG`, `PDF`, `PNG`, `JPEG`.

###stored (optional)
### stored (optional)
Store the QR Code in your Unitag Dashboard.

Values: If needed, set value to `true`.

###SIZE (optional)
### SIZE (optional)
Change the image size in pixels.

Values : integer between 0 and 3,000

###setting (required)
### setting (required)
Send custom parameters to your QR Code design.

The setting parameter value is JSON formated and contains all QR Code customizations parameters. See description and examples below

Can be replaced by the templateId parameter.

###data (required)
### data (required)
Send QR Code data.

The data parameter value is JSON formated and contains all QR Code encoded data. See description and examples below.

###templateId (optional)
### templateId (optional)
The parameter templateId can replace the parameter setting in order to indicate a Unitag Template to use as a design.

Values : If needed, set value to the targeted template id Integer.


##Data object##
## Data object ##

data = {
"TYPE" : "",
"DATA" : {}
}

###"Type" - STRING###
### "Type" - STRING ###

* url
* text
Expand All @@ -67,7 +67,7 @@ Values : If needed, set value to the targeted template id Integer.
* calendar
* call

###"data" - OBJECT###
### "data" - OBJECT ###

**Type : url**

Expand Down Expand Up @@ -175,7 +175,7 @@ Values : If needed, set value to the targeted template id Integer.
}


##Setting object##
## Setting object ##

setting = {
"LAYOUT" : {},
Expand All @@ -190,7 +190,7 @@ Values : If needed, set value to the targeted template id Integer.

*ARRONDI : Radius*

###LAYOUT - OBJECT###
### LAYOUT - OBJECT ###

LAYOUT : {
"GRADIENT_TYPE" : "",
Expand Down Expand Up @@ -235,7 +235,7 @@ _Note: FORCE_SHADOW is a shortcut for X_SHADOW/Y_SHADOW_
* "S" : Strong (value is 10)


###EYES###
### EYES ###

"EYES" : {
"COLOR_EHG" : "",
Expand Down Expand Up @@ -266,7 +266,7 @@ _Note: FORCE_SHADOW is a shortcut for X_SHADOW/Y_SHADOW_
* Sharp "Sharp"
* Curved "ECurve_ICurve"

###LOGO###
### LOGO ###

"LOGO" : {
"L_NAME" : "",
Expand All @@ -282,7 +282,7 @@ _Note: FORCE_SHADOW is a shortcut for X_SHADOW/Y_SHADOW_
The upper corner of the logo in the QR Code as a percentage. Omit to have it centered.


###BACKGROUND###
### BACKGROUND ###

"BACKGROUND" : {
"IMAGE_BACKGROUND" : "",
Expand All @@ -294,7 +294,7 @@ The upper corner of the logo in the QR Code as a percentage. Omit to have it cen

0 <= x <= 2

###E - STRING###
### E - STRING ###

QR Code redundancy :

Expand All @@ -303,7 +303,7 @@ QR Code redundancy :
* Quality : "Q"
* Strong : "H"

###BODY_TYPE - INT###
### BODY_TYPE - INT ###

Modules look :

Expand All @@ -320,11 +320,11 @@ Modules look :
* Rectangular : 8


###ARRONDI - INT###
### ARRONDI - INT ###

0 <= x <= 10

###TEXT###
### TEXT ###

Use this module to add text under the QR Code

Expand Down