Getting Started with apaleo APIs

 In Miscellaneous

Have a look

You can find all of apaleo’s API on api.apaleo.com. We use Swagger to describe it, and to generate our documentation.

Sign up

The first step is to sign up for your free trial account. After you finish signup you will be able to login to apaleo and start configuring your properties. Also you can use the same credentials to access our API using Swagger.

Get access for your app

Request your very own client credentials that lets you play with the API in your test account.

Use it

apaleo APIs are protected using OAuth2 – the de-facto standard for API security. Here’s a short guide to get you started:

Step 1: To get access to our APIs, you need to use your client id and secret to obtain an access token.

Combine your client id and secret into a string, separated by colon yourClientId:YourClientSecret and encode with Base64. This will result in one long string.

Make a call to https://identity.apaleo.com/connect/token, passing the encoded client credentials in the basic authorization header:

curl -X POST -d "grant_type=client_credentials" -H "content-type: application/x-www-form-urlencoded" -H "Authorization: Basic <your encoded credentials>" https://identity.apaleo.com/connect/token

Step 2: The connect/token endpoint will return the access token to pass in the header for all calls to the API, like so:

Authorization: Bearer <your token>

There’s a ton of tooling based on Swagger, that lets you generate clients in different languages. We recommend you check that out, before you start from scratch.

Recommended Posts