> For AI agents: the complete documentation index is available at /en/llms.txt, the full documentation bundle is available at /en/llms-full.txt.

# Usage Instructions

## ROIBest Main Process Flow Diagram

![Process flow diagram](/images/developer/img1.jpg)

## Update Log

### Ver 1.3.1

Release date: 2024/02/08

#### Changes

| Feature                     | Description                                                                                                 |
| :-------------------------- | :---------------------------------------------------------------------------------------------------------- |
| Unified Reporting Interface | Merged the individual reporting functions of kwai, tiktok, and facebook into the /report/fb/event interface |

**Note**: Existing clients using the `/report/fb/event` API are not affected by this change and do not need to take any action.

## API Usage Instructions

The ROIBest system's API is structured based on the HTTP protocol. The API requests and responses must be encoded in JSON format. Before using this API, the following prerequisites need to be completed:

1. Activate your ROIBest account and create an application.
2. Complete the ad placement on the advertising platform and obtain ad parameters, such as token and pixel id.
3. Configure the correct ad parameters in the ROIBest system backend.

### API Authentication Method

- [Data Open API](/en/developer/open-api.md): include `X-Api-Key` in the request header. Generate the API Key on the **Open API** page of the dashboard.
- Other APIs: no authentication is currently required.

### API Call Rate Limit

- [Data Open API](/en/developer/open-api.md): up to 10 requests per minute.
- Other APIs: no rate limits are currently imposed.

## API List

- [Advertising Event Reporting](/en/developer/event-report.md)
- [Query Landing Page Parameters via link_id](/en/developer/query-link-info.md)
- [Query Installation Success Events](/en/developer/search-event.md)
- [Data Open API: Query Visits and Installs](/en/developer/open-api.md)