Get your developer API keys

Welcome to Aurinko! This step-by-step guide covers how to set up a developer account in the Aurinko portal so that you can make your first request to the Aurinko API.

If you haven't already done so, please sign up or log into the Aurinko portal to access your account.

This guide covers the following steps:

  1. Get your application API keys
  2. Authenticate your first account
  3. Make your first request to the Aurinko API

Get your application API keys

One Aurinko application is automatically created for a new user. We recommend using different Aurinko applications to separate users across your development, staging, and production environments, but for the purposes of this guide use the automatically created one.

On the new application's dashboard page you will find the Client ID and secret. These values will be necessary when you're ready to work with accounts that are authenticated to your app.The client ID and secret are highlighted.

Authenticate your test account

For production use have to complete the todo's listed on your dashboard page but for now you can open the 'Add a test account' todo and click a link there. You will be presented wit the following dialog:

Select an account type (Google, Office 365, MS Exchange) and scopes for Calendar, Mail, Contacts. Then click AUTH.

Please note, that until you have configured your own Google and Office 365 authentication flows (see dashboard todo's) Aurinko's default app registrations with limited permissions are used (i.e. Google email is not available).

Once you have authenticated, you will see the Accounts page for your app. The new account record should be opened for you. Copy the provided token (click the little eye icon) and store it somewhere safe; you will need it to make your first requests to the Aurinko API.

Please note, this token should only be used for development purposes. 

Make Your First Request

Now that you have your first account connected, it's time to make your very first request to the Aurinko API! Open the nearest terminal and type in the following command, replacing  {access_token} with the token you saved from the previous section.

	curl -X GET -H 'Authorization: Bearer {access_token}' \
	https:/api.aurinko.io/v1/account

If everything is setup properly, you should see a response similar to the following example.

{
  "id":33,
  "serviceType":"Google",
  "status":"active",
  "daemon":false,
  "loginString":"demo@yoxel.com",
  "email":"demo@yoxel.com",
  "name":"Demo User",
  "authUserId":"...",
  "authOrgId":"yoxel.com",
  "authScopes":["Calendar.ReadWrite"],
  "tokenIssuedAt":"2019-12-27T19:43:14.187630Z",
  "authObtainedAt":"2019-12-27T19:43:14.187639Z",
  "authExpiresAt":"2019-12-27T20:43:14.179830Z"
}

Congrats! You're now connected to the Aurinko APIs!

Still need help? Contact Us Contact Us