Docs for URL shorter API

{% if apikey %} You API key is: {{apikey}}
{% endif %}

Make a request

The usage of the API is very simple, you have to make a push request to {{domain}}/user/api which have to include the folowing Arguments:

short: the short URL you want to get. example: {{domain}}/example
long: the long URL you want to short
qr: if you add this parameter you will get an base64 encoded QR code image
apikey: you can add this argument, if you want to assign this link to your account.
password: this value contains the password, that is needed to short a link.

example API call with curl: curl -d "{% if apikey %}apikey={{apikey}}&{% endif %}short={{domain}}/example&long=http://example.com" -X POST {{url_scheme}}://{{domain}}/user/api

Responses from Server

The response from the server is always made in json format it includes the following arguments:

status: The status code of the reponse. Down there is a table with the posible response codes
message: This argument will do the same like the status code, but it is written out, for reading by human.
qr: If you enabled this argument, the response will include a QR code of the shorten link as base64 coded jpeg image

Response codes:

{% if passwordProtected %} {% endif %}

Code	Meaning
0	Success
1	The short URL argument is missing
2	The long URL is missing.
3	The doamin for the short URL is not in the list of allowed domains
4	The short URL is already taken.
5	Wrong Password

Preview image

Please paste your base64 image here:
(this will not work very well in google Chrome)