Skip to main content

Get Your API Key

How to generate your bosta API key​

  • From the settings page choose the API Integration tab then Request OTP image info

  • Enter the confirmation code (OTP) that you received on your phone to start the generation of the API key. image info

  • After entering the code you received the page will look like the following, click on Create API key image info

  • Set a name, specify the permission and click Create image info

  • Make sure to copy the API Key before clicking done as you won't be able to access it again image info

How to use your bosta API key​

Simply you need to add this API key in your headers as the following 

{
  url http://app.bosta.co/api/v2/ \
  --header 'Authorization: Your API Key ' \
  --header 'Content-Type: application/json' \
  --data '{ }'
}

If you are using postman you can add it as in the following screenshot image info

Types of API keys​

We provide three types of API keys each one has a scope. A Scope means what that Key can access or edit in your data.

1 Read​

An API key of type read is able to only access endpoints with HTTP method of type GET

2 Read/Write​

An API key of type Read/Write is able to access any endpoint EXCEPT the endpoints with HTTP method of type DELETE

3 Full Access​

This type has the access to all actions you want (Create, Read, Update and Delete)

Create API key of Specific type​

Click on the button "Re-generate API Key" then we will give you the option to generate an API key with the scope you want.

image info


image info

Note that you can Enable or Disable your API keys or even delete any of them. image info

Every scope limit​

Now you can choose the scope you want depending on the actions or endpoints you want to use.

For example: