Ask AI

Delivami assistant

Ask Delivami AI

Get instant help with features, workflows, and best practices.

Suggested

AI may produce inaccurate information.

DelivamiDocs

API Keys

Authenticate programmatic requests to the Delivami API.

Overview

API keys allow you to securely interact with the Delivami API to automate workflows, build custom integrations, or sync data with external systems (like CRMs or ERPs).

API access is exclusively available on the Pro and Studio plans.

Creating API Keys

  1. Navigate to Settings > Integrations > API Keys.
  2. Click Create API Key.
  3. Provide a descriptive name (e.g., "Zapier Integration" or "Production Backend").
  4. Select the appropriate scopes (permissions) for this key.
  5. Click Generate.

Your API secret will only be displayed once. Copy it immediately and store it in a secure location (like a .env file or a secrets manager).

Authentication

When making requests to the Delivami API, include your API key in the Authorization header as a Bearer token.

curl -X GET "https://api.delivami.com/v1/projects" \
  -H "Authorization: Bearer YOUR_API_KEY_HERE" \
  -H "Content-Type: application/json"

Security Best Practices

  1. Never commit API keys to version control. Use environment variables.
  2. Apply the Principle of Least Privilege. Only grant the minimum required scopes when generating a key.
  3. Rotate keys regularly. You can create a new key, update your services, and then revoke the old one without downtime.

Next Steps

On this page