Authentication

Good to know: All requests require authentication.

Get your API keys

Your API requests are authenticated using API keys. Any request that doesn't include an API key will return an error.

You can generate an API key from your Dashboard at any time.

Make the Authentication request

Send an authentication request to the login endpoint. This will create a token, id and expiry which will form the headers of any request for the time until the expiry time passed.

Endpoint: https://settle.com/login

Take a look at how you might call this method using Http:

Request

POST http://settle.africa/login  HTTP/1.1
Content-Type: application/json
{  
    "id":"1234567890",
    "password":"jumairah"
}

Success

{
  "status": "success",
  "data": {
    "token":"tegdghh66353l",
    "id":"5563678883",
    "expiry":"29/11/2024 12:23:23"
    },
  "message": "Login Successfully",
  "code": 0
}

Failed

{
  "status": "failed",
  "data": {},
  "message": "User does not exist",
  "code": 1
}

Subsequent requests to the API will contain the Authenticated headers as follows:

id: 5563678883
token: tegdghh66353l
expiry: 29/11/2024 12:23:23

Authenticated Requests will look like:

GET http://settle.africa/profile  HTTP/1.1
id: 5563678883
token: tegdghh66353l
expiry: 29/11/2024 12:23:23
Content-Type: application/json

{  
}