API Documentation

Create a new short URL

Endpoint: POST /api/new

Parameters:

url (required) - The long URL to be shortened (parameter in POST data)
password (optional) - The password to that shortened URL (parameter in POST data) (we don't recommend to use in applications an URL with password, create another to it)

Check a short URL

Endpoint: GET /api/check/(id)?password=(password)

Parameters:

id (required) - The ID of the shortened URL (parameter in the URL)
password (optional) - The password of the shortened URL, if you won't pass it, it will not return the original URL (parameter in the URL query)

Front-end Routes

Redirect to a URL

Endpoint: GET /(id)?password=(password)

Parameters:

id (required) - The ID of the shortened URL (parameter in the URL)
password (optional) - The password of the shortened URL, if you won't pass it, it will not redirect to the original URL (parameter in the URL query)

Check a short URL (HTML response)

Endpoint: GET /check/(id)?password=(password)

Parameters:

id (required) - The ID of the shortened URL (parameter in the URL)
password (optional) - The password of the shortened URL, if you won't pass it, it will not return the original URL (parameter in the URL query)