Skip to content

Planning your integration

An overview of our platform

Consumer Intelligence enables you to connect your consumers in your systems to real persons in the real world. We build and maintain integrations to dozens of data providers (both internally and externally), unifying and enriching their data so that you can focus on your business needs.

Environments

Our platform also has two environments, each with its own purpose.

  • Production: Allows you to access real persons from our internal or externally available data providers. You will use this environment for your live system.
  • Sandbox: Allows you to access mocked persons and a limited set of API capabilities. You can use this environment to get started with integrating our API.

Clients

Access to our API is organized through clients. Each client has its own set of credentials used to access the API and identify the client. You can have one or more clients, depending on your needs. A common setup is to have one client for the live system and one for testing purposes.

Data is separated between clients, there's no way to move a user's data from one client to another or to share data between clients.

A client belongs to either the production or sandbox environment. There is no way to mix real and mock data in the same client, but you can have multiple clients in both environments.

Technical integration

The Consumer Intelligence platform is accessed through our HTTPS API, which is based on well established standards, universally accessible from modern infrastructures. The API is structured around REST architecture and OAuth2 2.0 authentication. This means you can bring your current stack and access our API through any language or framework.

All Consumer Intelligence API endpoints are meant to be accessed through your servers.

Building a backend

You will interact with the Consumer Intelligence platform via your own server. Your API credentials provide access to all your clients' data from Consumer Intelligence, and must be kept safe in your infrastructure.

Stay secure

Never share the API secret or access token with end users or store them outside your servers.

Your server manages all key tasks in relation to Consumer Intelligence:

  1. Authenticating: Exchanging the client credentials for a short-lived access token, used to authenticate all API calls.
  2. Making API calls: All calls to Consumer Intelligence API comes from your server, whether they are triggered by your user in your application or triggered by other logic.
  3. Managing real-time events: Handling incoming webhooks to get real-time events and data updates in your application.

Security

Your client credentials provide access to all consumer data tied to your client. The long-lived client secret is used to only request short-lived access tokens, and we recommend storing the secret in a secure enclave where it's only accessible to request the tokens.

Our API is only accessible via HTTPS, ensuring that all communication is encrypted.