API keys are used to authenticate all communication with the Interplai API web service. An API key is a simple encrypted string that identifies an application without any principal. They are useful for accessing public data anonymously and are used to associate API requests with the account for quota and billing. To gain access to the Interplai API web service, the API key should be embedded in the header with the custom field name x-api-key for each API call.
| Security Scheme Type | API Key |
|---|---|
| Header parameter name | x-api-key |
More information on API keys can be found here: Authentication.
Connect API keys are associated with the Interplai Connect web service. This special API key serves a different purpose than the API key; to connect the trips between the companies, the Connect API key needs to be shared. To gain access to the Interplai Connect web service, the connect API key should be embedded in the header along with API key with the custom field names such as x-api-keyand connect-api-key for each trip creation.
| Security Scheme Type | API Key |
|---|---|
| Header parameter name | connect-api-key |
More information on connect API keys can be found here: Connect Overview.