Skip to main content

Generating API Token

A step-by step guide on how to get access and start using S6 API. This article is useful for: Company Administrators.

Updated over a year ago

Creating an account

This guide will describe the process of accessing and using API. To follow the instructions, please make sure you have the tool that can send the requests to API (e.g., Postman) or someone from your IT department to help with this.

In order to access Sideways 6 API,  your account needs to have the admin permissions on Sideways 6 and a login and password which you will use to log in to Sideways 6. We generally advise on using a service account (e.g.s6api@yourcompanyname.com).

If you don't have a Sideways 6 account already created, please ask existing users to add you using these instructions. They would need to make sure that the 'Make this person an Admin' box was ticked when adding a new account. 

Once the account has been added to the Sideways 6 platform, you will find the invitation email in your inbox sent from support@sideways6.com with the subject “Company Invite”. You will need to: 

  1. Follow the link from the email and go through the process of setting up a password;

  2. Log-in to Sideways 6 using the password you have created to 'activate' your account so that it could be used to send requests to S6 API. 

Generating API Token 

In order to work with Sideways 6 API an API token needs to be generated. It should be done by using your access token (only admins' tokens can be used). You can generate the access token in two ways:

  1. Go to our API Documentation page and follow the instructions given there for the /api/v1/authorize request.
    ​

  2. You can get the access token by using a special software (e.g. Postman) and sending a POST request to this endpoint https://portal.sideways6.com/api/auth/login with a JSON object, username and password keys and values in the request's body to get your access token (only admins' access tokens can be used to generate an API token). In the response, you will get your access token. Don't forget to copy/save your access token, you will use it to send a request to generate the API token. 
    Once you have obtained your access token, your next step would be to generate the actual API token. You need to send a request to https://portal.sideways6.com/api/auth/generateApiToken and in the request, you need to send the header key Authorization and your access token (only admins') as a value and a body with the JSON object, password and expiryDate keys and values.  
    In the response, you will get the API access token which you need to use to send requests to the rest of the end-points to get responses with your company’s data on Sideways 6.

To get the list of all the endpoints please check our Sideways 6 API documentation.


​Note: only users with  admin permissions on Sideways 6 can have access to S6 API. If you are having any challenges using the API, please, feel free to contact the team via Intercom or drop us an email at support@sideways6.com

 

 
​

Did this answer your question?