Developer Account

The first thing you'll need to get started with our APIs is a developer account.

1. Create a user

New accounts are created via a POST request to the users API end point. The email address you provide should be valid since it will receive a confirmation email.

curl -H "Content-type: application/json" -X POST https://sandbox.xola.com/api/users -d '{
	"name" : "John Doe",
	"email" : "me@example.com",
	"password" : "<PASSWORD>"

The response will contain your user ID. Make note of it since you'll need it to retrieve your API key.

Sandbox accounts do not carry over to production

Most of our documentation provides examples for our Sandbox environment (sandbox.xola.com). Any credentials or resources you create in Sandbox will not carry over to Production (xola.com). You'll need to create a separate set of credentials for the Production environment.

2. Activate your account

Once the user is created, a verification email is sent to you. It is necessary to click on the verification link to activate your account.

3. Get your API key

Once you've verified your account, you can access your API key.

curl https://sandbox.xola.com/api/users/<USER_ID>/apiKey -u "me@example.com:<PASSWORD>"

All future requests don't require your username and password. You'll just use the API key for authentication.

4. Try it out

Try fetching your user information using your API key.

curl -H 'X-API-KEY: <API_KEY>' https://sandbox.xola.com/api/users/me

Developer Account

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.