shrtlnk
Documentation
Dev Portal
Sign InSign Up

Shrtlnk API Documentation

The API consists of a single POST endpoint that takes in the URL you would like to shorten.

  • URL: https://shrtlnk.dev/api/v2/link
  • Required Headers: 
    api-key: Your API key
Accept: application/json
Content-Type: application/json

  • Request Body

    1{
2  url: string // The URL that you would like to be shortened.
3}

  • 201 - Successful Response Body

    1{
2  url: string // The URL that was passed in the request.
3  key: string // 6-digit key that can be used to reference the shortend URL.
4  shrtlnk: string // The fully qualified shortened URL that you can return to the user.
5}

  • 400/500 - Error Response Body

    1{
2  message: string // A message describing the error and/or how to fix it.
3}