API Key

API Key Management endpoints provide tools for creating, viewing, updating, and deleting access keys that are used for authentication and API interaction control. Using these methods, you can get a list of existing keys, create new ones, change their parameters, temporarily disable or delete them if necessary. All operations provide secure access control and allow you to flexibly control the level of rights, restrictions, and lifecycle of each API key.

Create ApiKey Request#

POST

await client.createApiKey(pid, data)

request parameters
response parameters
After submitting a call, you receive a response message to inform you that your request was received and processed.Depending on the HTTP status code of the response message, it is helpful to build some logic to handle any errors that a request or the system may return.
HTTP Responses

Delete ApiKey Request#

DELETE

await client.deleteApiKey(pid, data)

request parameters
response parameters
After submitting a call, you receive a response message to inform you that your request was received and processed.Depending on the HTTP status code of the response message, it is helpful to build some logic to handle any errors that a request or the system may return.
HTTP Responses

Get ApiKey list Request#

GET

await client.getListApiKey(pid)

request parameters
response parameters
After submitting a call, you receive a response message to inform you that your request was received and processed.Depending on the HTTP status code of the response message, it is helpful to build some logic to handle any errors that a request or the system may return.
HTTP Responses

© 2024 BigState