This article introduces the CXI Public API, which is a REST-based API for interacting with the CXI platform. It covers the basics of API authentication using API keys, how to obtain these keys, and the importance of keeping them secure. The API uses standard HTTP protocols, accepts form-encoded requests, and returns JSON-encoded responses.
Information
API Reference
The CXI Public API is organized around REST. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes and authentication.
Authentication
The CXI Public API uses API keys to authenticate requests. If you do not include your key when making an API request, or use one that is incorrect or revoked, the CXI Public API will return an error response:
Response 401 (Unauthorized)
Every account can generate multiple keys for different purposes.
Obtaining your API keys
Request your API keys from your Tivian team by contacting them or submitting a ticket. We include randomly generated API keys in our code examples. Replace these with your own API keys.
Keeping your keys safe
Your secret API key can be used to make any API call on behalf of your account, such as creating audience imports or export some results. Treat your secret API key as you would any other password. Grant access only to those who need it. Ensure it is kept out of any version control system you may be using.
GO TO: CXI PUBLIC API: Audience Import Capabilities
FAQ
What authentication method does the CXI Public API use?
The CXI Public API uses API keys for authentication. Each account can generate multiple keys for different purposes, and requests without a valid key will result in a 401 Unauthorized error.
How can I obtain API keys for the CXI Public API?
To obtain API keys, you need to request them from your Tivian team by contacting them directly or submitting a ticket. It’s important to note that the API keys shown in code examples are randomly generated and should be replaced with your own keys.
Why is it important to keep API keys safe?
API keys, especially secret keys, provide full access to make API calls on behalf of your account. They should be treated like passwords, with access granted only to those who need it. It’s crucial to keep them out of version control systems and to protect them as you would any sensitive credential.