Authentication

The Novant API uses API keys to authenticate requests and is scoped by project. You can view and manage your API keys in the Novant Dashboard.

API keys are alphanumeric strings, which are prefixed with ak_ to help identify. Example code uses the sample key ak_sample_123. This key is non-functional and is used for demonstration purposes only. Replace the key with your own key for production.

Your API keys carry many privileges, so be sure to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, etc.

Authentication to the API is performed via HTTP Basic Auth. Provide your API key as the basic auth username value. Use a empty string as your password.

All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.

# The colon after API key prevents curl from asking for a password
curl https://api.novant.io/v1/project \
  -X POST \
  -u ak_sample_123: \
  --compressed