API Authentication
To use our APIs, you first need to obtain an authentication token. To do this, you must create an API Access user in the Customer Portal.
Create a New User with API Access
- Log into the Customer Portal.
- From the menu at the left side of the page, click User Management.
- Click the Create New User/Contact button.
- On the User/Contact Details pop-up, fill in the Full Name, Email, and Phone.
- Click Create Login.
- Enter a unique name in the Username field, and select API from the Access drop-down list.
- Click Save.
An email with your username and password is automatically sent to the email address you entered.
Obtain Your Token
Once you have created an API Access user, you can use one of two methods to obtain your token.
Through the CPaaS Portal
To retrieve a long-standing token for use with the CPaaS List Management API, log into the CPaaS Portal. On the landing page, API Authentication Token section, click Copy. You're ready to go!
Through the Customer Portal
To retrieve a short-term, 24-hour token for use with all other APIs, using the username and password you created for the API Access user, make the following request:
Note: Once the 24-hour token expires, repeat the request to get a new token.
Request
POST https://customer.intelepeer.com/_rest/v4/authenticate
Content-Type: application/json
Accept: application/json
Important: If you are using Postman to send your API requests, make sure to add the following Keys in the Headers section: Content-Type: application/json and Accept: application/json
Success Response
Successful authentication. Token returned in the body of the response.
Related Errors
Note: If you are unable to retrieve your token, confirm the user you created has been granted API access in the Customer Portal, and your username and password accuracy in the body of the request.