The API uses Basic HTTP Authentication with your account email and password.
To create the Authorization header, encode "email:password" to base 64 and prepend it with "Basic" (i.e. "Authorization: Basic ZW1haWw6cGFzc3dvcmRPckFwaUtleQ=="). The -u curl option does this automatically.
API keys can also be used in lieu of passwords. Note that login two factor authentication must be turned off to authenticate using a password. Use an API key or API token created using two factor authentication (described in the Authorization section below) to authenticate an account with login 2FA turned on.
curl -X GET -u `{email}/key:{key}` https://www.keycafe.com/v0/keyAn API key can be generated in your account settings.
Deprecation Notice: API KeysAPI keys are now deprecated. For improved security and efficiency, we strongly recommend switching to tokens for API authentication.
Responses
Successful responses will have status code 200.
Errors will usually have status code 400 (validation error) or 500 (internal server error) and the response will contain a JSON object representing the specific errors.
| error.errorId | An error ID. |
| error.errorMessage | A description of the error. |
General Error Codes
| error.unknown | An unexpected error has prevented the request from completing. If the issue persists, please contact Keycafe support. |
| operation.notFound | The specified PUT operation is not supported by this endpoint. |
| method.notAllowed | The specified HTTP method is not supported by this endpoint. |
| action.forbidden | The endpoint is only available to authenticated users. |
Request Headers
| Accept-Language | Specifies the locale to prioritize for all responses. If omitted or an unsupported locale is specified, the authenticated user's default locale will be used. The expected format includes case-insensitive ISO 639 alpha-2 language codes and ISO 3166 alpha-2 country codes. (i.e. en-US, fr_ca, etc...) |
Rate Limiting
Requests are rate limited to 60 per 1 minute. Exceeding this limit will result in all requests failing with status 429 for 1 minute.
API Fair Use Notice
While observing rate limits is important, responsible API use also entails avoiding repetitive or erroneous requests and adapting to feedback from error responses. Continual disregard for these principles, including making unfulfillable requests, can lead to access restrictions. We encourage users to be considerate in their usage, as our monitoring aims to maintain a stable and efficient service for all.