#
Authentication
#
Introduction
To use our API, you will need to generate an API key through the Merchant Dashboard.
You can't create an API Key with zero branches. You must have at least one branch in your account. Then you can link that branch with a new API Key.
If you don't have a branch, Follow these steps to create one:
- Open Sidebar by clicking on the Menu icon in the top left corner of the screen.
- Open Settings page.
- Open Manage branches page.
- Click on "create new branch" button.
#
Generate API Key
- Open Sidebar by clicking on the Menu icon in the top left corner of the screen.
- Open Settings page.
- Open API settings page.
- In the
API Keys
section, Click on "create new key" button. - Select a branch.
- Add a webhook link if you want (Optional - See webhooks section).
- Click on "Generate" button.
Once you have the API key, You will need to include it in the headers of all API requests as the
Authorization
parameter, prefixed by the wordKey
.
#
Examples
curl --location --request GET 'https://api.armadadelivery.com/v0/deliveries/:orderCode' \
--header 'Authorization: Key 4a3bc2e1-f6a2-4e5d-8c2f-9d0b5a4b3928'
fetch('https://api.armadadelivery.com/v0/deliveries/:orderCode', {
method: 'GET',
headers: {
'Authorization': 'Key 4a3bc2e1-f6a2-4e5d-8c2f-9d0b5a4b3928'
}
})
.then(response => response.json())
.then(data => console.log(data))
.catch(error => console.error('Error:', error));
func main() {
url := "https://api.armadadelivery.com/v0/deliveries/:orderCode"
req, err := http.NewRequest("GET", url, nil)
if err != nil {
fmt.Println("Error creating request:", err)
return
}
req.Header.Set("Authorization", "Key 4a3bc2e1-f6a2-4e5d-8c2f-9d0b5a4b3928")
// ....
}