Account
Your code can manage the API keys of your account and read how much of its quotas it has used with the endpoints below /v1/account. PUT /v1/account/apikey creates a new API key and returns it, GET /v1/account/apikeys lists the existing keys and DELETE /v1/account/apikey deletes the key given in the key parameter. GET /v1/account/settings returns the serial number of the account (Trial on a trial account, or the 13-character serial number of a subscription), the date until which the subscription is valid (null on a trial account), how many documents and proofing transactions the account has used this month and how many templates it stores, each with its maximum.
The .NET SDK calls them with CreateAccountAPIKey, GetAccountAPIKeys, DeleteAccountAPIKey and GetAccountSettings, the PHP SDK with createApiKey, getApiKeys, deleteApiKey and getAccountSettings, the Java SDK with createAPIKey, getAPIKeys, deleteAPIKey and getAccountSettings, and the Ruby SDK with create_api_key, get_api_keys, delete_api_key and get_account_settings. An account can have up to 10 API keys, which can also be created and deleted in the portal: API Keys explains both ways, and Plans and Licensing the quotas that the settings report.
Methods
| Method | Endpoint | Description |
|---|---|---|
DELETE | /v1/account/apikey | Deletes a ReportingCloud API key from the list of existing API keys. |
PUT | /v1/account/apikey | Creates and stores a new ReportingCloud API key to the list of API keys. |
GET | /v1/account/apikeys | Lists all available ReportingCloud API keys from the existing keys. |
GET | /v1/account/settings | Returns detailed information about the account quota and general settings. |