Using Open API
Introduction
This guide is an Open API guide developed to download/update or create data stored in DFINERY.
[[Quote:Risk:Medium]]
Notice
DFINERY
To use Open API, a paid plan upgrade is required.
(Free plan not supported)Token availability varies depending on the plan.
[Provision policy]
- When upgrading ‘Free Plan -> Paid Plan’: New token can be issued
- When downgrading from ‘Paid Plan -> Free Plan’: Immediate suspension of issued tokens
- When re-upgrading ‘Free Plan -> Paid Plan’: Immediately reactivate suspended tokens
Using Open API
API Token Issuance
In order to use Open API, an API Token must be issued through the DFINERY Console.API Token is urgent as below.
- After logging in to the DFINERY console, select Application from the Setting & SDK menu on the left menu.
- Check the app that will use Open API in the app list and click the “Manage” button.
-
Click the Token menu in the bottom menu.
-
If there is no Token created, click the “+ Add” button.
-
Check the generated token.
[[Quote: Information: Normal]] If the issued token is deleted or reissued, the existing token can be used for up to 14 days.
Rate Limit
[[Quote:Guide:General]] API Rate Limit varies by token type. For User Profile API, the default rate is 10,000 per minute. For Event API, the default number is 10,000,000 per minute. If you would like to increase the limit, please contact DFINERY Customer Success Team. [Contact DFINERY Customer Success Team]
If you want to check the rate limit status, you can check it through the X-Rate Limit value in the Response Header.
| Header Name | Type | Description |
| X-Rate-Limit-Limit | string | Limit criteria (period - y, M, d, H, m, s) |
| X-Rate-Limit-Remaining | integer | Within limits, remaining views |
| X-Rate-Limit-Reset | integer | Limit Time stamp when the limit rule is reset |
Example
| X-Rate-Limit-Limit | X-Rate-Limit-Remaining | X-Rate-Limit-Reset | |
| In case of 100,000 cases per day | 1d | 99,999 | 1682640000000 |
| In case of 10,000 cases per hour | 1H | 9,999 | 1682593200268 |
| In case of 10,000 cases per minute | 1m | 9,999 | 1682593020036 |