Connecting to the API
- David Boyajian
- Claudio Baldi
In order to connect to the PS API every supplier must have the follow access :
API PureSpectrum user account (https://purespectrum.atlassian.net/wiki/spaces/~738389890/pages/991265022 )
API PS account is used only to interface your system with our platform programmatically. During the onboarding we ask to all our Supplier a valid email and we will provide the user with a TOKEN that will be use to have a secure tunnel between our and the supplier system.
The API PS Account cannot be use to access to the PS platform and the supplier needs to use the UI PureSpectrum user account.
The Token is issued by the PureSpectrum representative and must be secret and not shared with anyone. In case you lost the Token please contact your first point of contact and we will send you again.
To access the API, the supplier will need to include the Token as an authorization parameter in the request header. The parameter name used to auth the request is “access-token”
How to use the Token:
Each request needs to include your API access token.
Parameter | Type | Required | Description |
|---|---|---|---|
access-token | String | Yes | Token used to identify the authenticity of the user. |
Example:
headers: { 'access-token': '$accessToken' }Please do not expose your access-token to anyone or in public as this could compromise the Integrity of your integration.
The Supplier API uses standard HTTP status codes to indicate success or failure of an API Request. In general, API status would indicate success or failure status.
Parameter | Value |
|---|---|
status | "Success" or "Failure" |
msg | A detailed error message describing what went wrong |
Status Code Summary
200 | Everything Worked As Expected |
400 | Bad Request |
403 | Invalid Access Token |
404 | Resources Not Found |
5xx | Something Went Wrong On PureSpectrum |
Postman example:
