Get started

You can send events and properties of online/offline users and extract data through DFINERY's API.

Before you start

Before using DFINERY's API, the following must be prepared in advance.

1. Sign up and create an organization and service : To use the API, you must sign up and create an organization and service. For more information, refer to Getting Started with DFINERY in the User Guide.

2. Registering Events and User Attributes : DFINERY only loads pre-registered event and user attribute data. If there are any events and user attribute data that you want to load, you must register them in advance in the console. For more information, refer to Getting Started with DFINERY in the User Guide.

3. API Token Issuance : DFINERY uses API tokens to determine whether a request sent by a user is an authenticated request. API tokens can be issued through the DFINERY Console. For more information, see Authentication.

4. Consider API request limits : DFINERY limits the number of API calls per hour for each service. When making API requests, you should design your requests to take API request limits into account. For more information, see Request Limits.

API

Domain

DFINERY API uses one domain below.

URL	Explanation
https://openapi.dfinery.ai	DFINERY API domain

API Collection

DFINERY provides the following types of APIs:

Classification	Explanation
Event	You can load user event data.
Identity	Update user identification information. This allows us to identify and integrate users.
Profile	You can update user properties.
Export	You can extract user event and behavior data loaded in DFINERY.

Data Type

DFINERY API uses consistent data types and formats. When users connect to the API, they must make requests that match the data types required by the API.

Please refer to Data Types for more details .

Certification

DFINERY uses API tokens to determine whether a request sent by a user is an authenticated request. All API requests must include an API token in the header. API tokens can be issued through the DFINERY console.

DFINERY's API tokens are divided into Import API and Export API tokens. Import API tokens are used when sending customer data to DFINERY (Event, Identity, Profile API). Export API tokens are used when customers extract data loaded in DFINERY (Export API).

Please refer to Certification for more details .

Import API Token

access_token: ${your-import-api-token}

Export API Token

Authorization: Bearer ${your-export-api-token}

Request Limit

DFINERY limits the number of API requests per hour for each service to ensure stable service operation. If the API request limit is exceeded, all subsequent requests will fail, and after the time limit has elapsed and the request limit is reset, the request will succeed. For more information about API request limits, see Request Limits.