Onboarding API Management
If you want to get access to an API-product, follow the steps as described below:
Side-note: Before requesting access to an API-product be sure to look at the product Overview and Details on the API Products page. Also make sure that you have an account for ServiceNow. If you don't have an account, contact the Servicedesk.
Introduction
To access the API-Products provided through the Translink API management layer, you need the following:
- Client certificate
- Client ID & Client Secret
- API Key – Authentication
- API Key – Product (e.g., PAD Management)
When making API calls, you will need a combination of the following:
- Client certificate (for a secure connection)
- Bearer Token (See “Client ID, Client Secret, and API Key Authentication” later on this page)
- API Key (for the specific product)
Client Certificate
A client certificate adds an extra layer of security. To obtain a client certificate, submit a ServiceNow ticket to our Servicedesk. Please consult the following page before submitting a ticket: Contact & Service Requests.
When submitting a ticket, ensure you mention the environment (ACC or PROD) and service (API management) the certificate is for. After submitting the ServiceNow request, you’ll receive detailed instructions on creating a CSR and Hash, which are needed to create the certificate. Sending the certificate is always required when making API calls.
Client ID, Client Secret, and API Key Authentication
To create a bearer token, you need a combination of a Client ID, Client Secret, and an API Key for the Authentication product. You can obtain a bearer token through API 1020 - Access Token For Client, User and for token Exchange..
To use API 1020, the following parameters/attributes are required:
- realm
- client_id
- client_secret
- grant_type
A bearer token is a type of access token used to authenticate requests to an API. When a client makes an API call, it includes the bearer token in the HTTP header to prove its identity and gain access to the requested resources.
To obtain the Client ID, Client Secret, and API Key needed for the Authentication product, submit a ServiceNow ticket to our Servicedesk. Please consult the following page before submitting a ticket: Contact & Service Requests.
When submitting a ticket, ensure you mention the environment (ACC or PROD) and service (API management) the credentials and API key are for. It’s also helpful to note that this ticket is for the API Services team. Once the Client ID, Secret, and API Key are available, they will be shared in a secure file.
API Key (for products)
When making API calls to specific products (e.g., PAD Management), you need the API Key for that specific product. To obtain this API Key, submit a ServiceNow ticket to our Servicedesk. Please consult the following page before submitting a ticket: Contact & Service Requests.
When submitting a ticket, ensure you mention the environment (ACC or PROD) and Product the API is for. It’s also helpful to note that this ticket is for the API Services team. Once the API Key is available, it will be shared in a secure file.
When we receive your request it wil be reviewed and when approved, access to the API product will be added to your consumer. We will inform you when this is done. If your application is rejected for any reason we will of course inform you about our decision. Requests are generally solved within 1 to 3 weeks.