Skip to main content

Authentication

To authenticate your requests, you need to include a valid API key in the Bearer header of your HTTP requests. Your API key has been sent to you after validating your email address.

Step 1: Obtain API Token​

  1. Register:

    • Go to Homepage.
    • Sign up for an account
    • Validate your registration by verifying your email address.

  2. Store Your API Token:

    • Once generated, securely store the API key. Treat it like a password and do not share it publicly.

Step 2: Include API Token in Requests​

Add the API token to the Bearer header of your HTTP requests.

GET /v1/some-endpoint HTTP/1.1
Host: api.lynkr.dev
Authorization: Bearer YOUR_API_KEY

Example​

Let's look at a complete example of making an authenticated request for retrieving your account information using a tool like cURL.

curl -X GET https://api.lynkr.dev/v1/accounts/current -H 'Authorization: Bearer YOUR_API_TOKEN'

Error handling​

If authentication fails, the API will respond with a 401 Unauthorized status code. Double-check that you are using a valid API key and have included it correctly in the Bearer header.