Create API Key
Last updated
Last updated
Supametas.ai Service API uses API-Key for authentication.
It is recommended that developers store the API-Key in the backend, rather than sharing it or storing it on the client side, to avoid the leakage of the API-Key, which may lead to financial loss.
On the "API Configuration" page, you can manage API keys to push data to external systems or applications. API key management includes creating new keys, deleting keys, and starting data pushes.
Create New Key
Click the "+ New Key" button to open the new key creation window. :
Enter a key name： In the "Alias of key" field, enter a descriptive name to identify the purpose of the key.
Click the "OK" button to complete the key creation. The newly created key will appear in the list.
Delete Key
In the API key list, select the key you want to delete.
Click the "Delete" button, and the system will delete the selected key and stop all data push operations related to that key.
You must connect the API to the system that requires integration and set the webhook address before you can start the data push; otherwise, the push will fail.
Select API: In the API list, check the keys that need to be pushed via API.
Click the "Start Real-time Push" button, and the system will immediately begin pushing the cleaned data to the external system in real time.
Historical Data Push :
If there is data in the dataset that needs to be pushed as historical data, click the "Historical Data Push" button. Historical data push will only start after this button is clicked.
The status of historical data push will be shown in the list, displaying the push progress (e.g., "Historical Data Push Progress 1%").
Historical data push will only occur once. After completion, the same data will not be pushed again.
If you need to stop the current push task, you can either delete the API key from the list or stop the API operation in the integrated system to terminate all related push tasks.
