shortCuts

For better view, use on desktop
1.2.5
API Playground
GET

/api/token

content-type: application/json

Summary

Generate a token to enable analytics and other functionalities

Responses

Successfull Response

    {

  • token

    :

    str

    //Unique token which is supplied with link (optional)

    ,

  • created_at

    :

    time

    //Time when stored in database

    ,
    • }

POST

/api/link

content-type: application/json

Summary

Shorten a link

"schedule_delete" excepts any valid date object [Try to give iso date string].


Parameters

  • link

    • type : string
    • isOptional: false

  • short_link

    • type : string
    • isOptional: true

  • is_preview

    • type : boolean
    • isOptional: true

  • token

    • type : boolean
    • isOptional: true

  • schedule_delete

    • type : datetime object
    • isOptional : true

Responses

Successfull Response

    {

  • link

    :

    str

  • short_link

    :

    str

    //Five charachter code

    ,

  • timestamp

    :

    int

    //timestamp when stored in database

    ,

  • is_preview

    :

    bool

    ,

  • unique_id

    :

    str

    //10 digit unique hex code

    ,
    • }

GET

/{id}

content-type: application/json

Summary

Redirect to original route OR respond with JSON

Parameters

  • id

    • type : string
    • isOptional: false

Responses

Successfull Response

Redirect to Link or preview page


GET

/api/count/{token}/{unique_id}

content-type: application/json

Summary

Get clicked analytics

Parameters

  • unique_id

    • type : string
    • isOptional: false

  • token

    • type : string
    • isOptional: false

Responses

Successfull Response

    {

  • count

    :

    number

    • }

PUT

/api/update/

content-type: application/json

Summary

Update information about some links

Parameters

  • token

    • type : string
    • isOptional: false

  • unique_id

    • type : string
    • isOptional: false

  • link

    • type : string
    • isOptional: true

  • short_link

    • type : string
    • isOptional: false

  • is_preview

    • type : boolean
    • isOptional: false

Responses


DELETE

/api/delete/

content-type: application/json

Summary

Delete a short link

Parameters

  • token

    • type : string
    • isOptional: false

  • unique_id

    • type : string
    • isOptional: false

Responses


API playground