Security

Client certificate

All calls to a API requires a valid client certificate. TietoEVRY recommends this requirement both on the Internet and on internal networks. The customer is responsible for providing the external actor (API consumer) with a suitable client certificate.

API key

All calls to a API requires a API (license) key. The API key will be produced by TietoEVRY and distributed to the customer.
The API key contains the following information:

  • The API consumer
  • The customer's meta domain
  • Allowed APIs
  • The expiration date

The API key should, if possible, be sent in the HTTP header instead of in the query-string, some web servers may otherwise log the API key.

Data in HTTP headers

All parameters in the query-string could also be sent as HTTP headers, and this is a more secure way of sending sensitive data. Use the prefix 'X-API-' for the parameter in the HTTP header. For example: X-API-key: <API key>

Act as an end-user

To act as an end-user, the end-user must first obtain an access token (OAuth 2.0) and then attach it to the API call. The access token must be sent in the HTTP Header 'Authorization' with the scheme 'Bearer' (Authorization: Bearer <AccessToken>). To act as a certain role or roles (separated by comma), use the query-string parameter 'roles'. In the provider sub domain, the role is connected to a provider unit. So to act as a certain role or roles in the provider sub domain, use the query-string parameter 'roles' together with the query-string parameter 'provider_unit'.