WLink API

From version 1.2.0 WLink comes with an API which can be used to automate the process of creating, deleting and fetching links.

Accepted content types for WLink are application/json or application/x-www-form-urlencoded.

Getting Started

Before starting with the API ensure the following are done

WLink is running on version 1.2.0 or later
The API token has been changed in the config.json file

Routes

Below are the three available routes in WLinks API.

GET /api/link/:name

Fetch a link that is in the database. The URL name can be the name or url in WLink.

Parameters:

`authorization`	[Header] The token set in the config file
`name`	[URL] The name or url of the link to search for

Response: ^[Expand]

2xx:

{
  id: 2,
  name: 'g',
  url: 'https://google.com',
  count: 7,
  creator: 'faxes',
  creatorID: '282762192544333827',
  createdAt: '1713090722076'
}

4xx:

{ msg: 'Link not found from name or url.' }

POST /api/link

Creates a link into the system

Parameters:

`authorization`	[Header] The token set in the config file
`name`	[Body] The short name for the link
`url`	[Body] The url the link should direct towards

Response: ^[Expand]

2xx:

{
  id: 2,
  name: 'g',
  url: 'https://google.com',
  count: 0,
  creator: 'API',
  creatorID: '0',
  createdAt: '1713090722076'
}

4xx:

400: {msg: 'Body fields not passed, name and url are required.'}
409: {msg: 'Duplicate link name.'}
403: {msg: 'Reserved name provided. Paths that the application use are reserved.'}

DELETE /api/link/:id

Deletes the link from WLink and returns the last data for the link.

Parameters:

`authorization`	[Header] The token set in the config file
`id`	[URL] The numerical ID of the link to delete

Response: ^[Expand]

2xx:

{
  id: 2,
  name: 'g',
  url: 'https://google.com',
  count: 7,
  creator: 'faxes',
  creatorID: '282762192544333827',
  createdAt: '1713090722076'
}

4xx: