Url's

All info about the stedelijkleiden.nl shortlink system!

Get code

GET https://stedelijkleiden.nl/api/u/get/:code

This endpoint allows you to get information about a code.

Path Parameters

Name	Type	Description
id	string	The code of the shortlink, for example stedelijkleiden.nl/docs (docs)

200 Code successfully found.

{
    "code": "docs",
    "longUrl": "https://docs.stedelijkleiden.nl/",
    "shortUrl": "https://stedelijkleiden.nl/docs",
    "private": false,
    "clicks": 7
}

404 Could not find a Code matching this query.

{
    "message": "Code not found!"
}

Get list of all codes

GET https://stedelijkleiden.nl/api/list

Get a list of all existing public codes.

Path Parameters

Name	Type	Description
None	string	No parameters required

200 Successfully got all public codes!

[
    {
        "code": "zermelo",
        "link": "https://gymnasiumleiden.zportal.nl/",
        "clicks": 10
    },
    {
        "code": "itslearning",
        "link": "https://sgl.itslearning.com/",
        "clicks": 8
    }
]

Delete a code

POST https://stedelijkleiden.nl/api/u/delete

Delete an existing code with your API key!

Request Body

Name	Type	Description
key	string	You api key secret!
id	string	Your api key id!
code	string	The code of the shortlink, for example stedelijkleiden.nl/docs (docs)

201 Your code is successfully deleted!

{
    "message": "Success!"
}

401 Your API key is not valid!

{
    "message": "Api key is invalid!"
}

404 The code is not found, so it can't delete it or you are not the owner of the link!

{
    "message": "Url not found!"
}

Create code

POST https://stedelijkleiden.nl/api/u/create

Request Body

Name	Type	Description
id	string	Your API key id!
key	string	Your API key secret
private	string	IF the url is visible in the list!
customUrl	string	A custom name for the url!
longUrl	string	The long url to shorten!

201 The code is successfully created!

{
    "code": "calendar",
    "longUrl": "https://calendar.google.com/",
    "shortUrl": "https://stedelijkleiden.nl/calendar",
    "private": false,
    "clicks": 0
}

304 The custom url already exists!

{
    "message": "Custom url already exists"
}

400 The url already exists or the url is invalid!

Url exists

{
    "message": "URL already exists"
}

Invalid url

{
    "message": "Invalid longUrl"
}

401 The given API key is invalid!

{
    "message": "Api key is invalid!"
}