Authentication

Authenticate your API requests

The Parvenu API uses an API Key and username to authenticate requests.

You can view and manage your access tokens in Settings → API key of your Parvenu account and clicking "Generate key".

API Key

Please be sure to keep your API access tokens secure! Do not share them in emails, chat messages, client-side code or publicly accessible sites.

Access tokens are tied to the Parvenu user account for which they were created. An API key provides the same level of access & privileges that its associated Parvenu user account would have.

API requests are authenticated in the body. To authenticate a request, provide the API Key, username associated with your account, and email associated with your account.

Base URL

POST https://api.parvenu.io/

Base URL and authentication schema.

If the key is missing

Leave api_key out of the body and the call comes back in the standard error shape:

{
  "status": "error",
  "error": {
    "code": "validation_error",
    "message": "api_key: Field required"
  },
  "success": false
}

Every endpoint answers in the same envelope, success or failure. See Response Format.