Create and read your shortlinks with the Rest API.

Getting started

1. Generate your API key

   Open the Rest API tool in your dashboard and choose Generate API key. The key is shown only once, so copy it right away and store it somewhere safe.

2. Send it with every request

   Add your key in the Authorization header as a Bearer token. Requests without a valid key are rejected.

3. Read the response

   Responses are JSON. Successful creates return status 201, reads return 200, and failures return an error code you can match against the table below.

Endpoints

curl -X POST https://api.safelinkme.net/api/v1/links \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://example.com/page","alias":"my-code"}'

{
  "id": 123,
  "code": "my-code",
  "customAlias": true,
  "destUrl": "https://example.com/page",
  "createdAt": 1790000000000
}

curl "https://api.safelinkme.net/api/v1/links?page=1" \
  -H "Authorization: Bearer YOUR_API_KEY"

{
  "links": [
    {
      "id": 123,
      "code": "my-code",
      "custom_alias": 1,
      "dest_url": "https://example.com/page",
      "status": "active",
      "views": 0,
      "earnings": 0,
      "created_at": 1790000000000
    }
  ],
  "page": 1,
  "pageSize": 50
}

curl https://api.safelinkme.net/api/v1/links/my-code \
  -H "Authorization: Bearer YOUR_API_KEY"

Custom aliases

An alias must be 3 to 30 characters using lowercase letters, numbers, hyphens, and underscores. It cannot start or end with a hyphen or underscore, cannot contain two hyphens in a row, and cannot match a reserved word such as a page name on the site. Aliases are converted to lowercase and must be unique across the platform.

Error codes

Keeping your key safe