Tediware
Sign In

Authentication

All Platform API requests require an API key. The API key identifies your organization and grants access to the partners, flows, and results within it.

API Keys

API keys are managed from the API Keys page in the application. Each key belongs to your organization and has a name for your reference.

To create a key:

  1. Navigate to Settings then API Keys
  2. Click New API Key
  3. Enter a name (e.g., “Production” or “Staging”)
  4. Click Create

The full key is displayed only at creation time. Copy it immediately and store it securely – you will not be able to retrieve it again. Subsequent views show only a masked version.

You can create multiple API keys for different environments or integrations. Each key has the same level of access within your organization.

Making Requests

Include your API key in the Authorization header using the Key scheme:

Authorization: Key your-api-key-here

All API endpoints use the base path /platform/ and return JSON responses.

Example request:

curl -X GET "https://tediware.com/platform/results" \
  -H "Authorization: Key your-api-key-here"

If the key is missing or invalid, the API returns a 401 response:

{
  "error": {
    "message": "API key is missing",
    "code": "unauthorized"
  }
}

Revoking a Key

To revoke an API key, navigate to Settings then API Keys, find the key, and click Delete. Any requests using that key will immediately begin returning 401 responses.