Skip to main content

Create an API key

Back to the main guide

An API key gives an external application a direct, authenticated connection to the Ordering.co API for a project, without requiring a user to log in for every request.

Generate a key​

  1. Log in to the Dashboard and open the project you want to connect.

  2. Select Settings at the bottom of the left-hand sidebar.

  3. In the settings view, select Developers when it is available.

  4. In the Developers panel, select the API Keys card.

    API Keys card in the Developers panel

  5. Select Add API Key.

  6. A new alphanumeric key appears. Copy it immediately and store it securely.

    Newly generated API key ready to copy

Keep your key secure​

An API key provides a direct connection to the API without further authentication, so treat it like a password:

  • Don't share it in public chats or messages.
  • Don't commit it to a public GitHub, GitLab, or other version-controlled repository.
  • If you suspect a key has been compromised, delete it from the API Keys card and generate a new one immediately.

Use your key​

Once you have a key, add it as the x-api-key header on your API requests. See Use the Ordering.co API for how to make your first requests, and API Reference for the full set of available operations.