Authentication

SMARTe Discover APIs use API key authentication to securely identify and authorize API requests.

API key authentication identifies your organization using a static credential issued during provisioning. This method is commonly used for server-to-server integrations and batch workflows.

Authentication Method

SMARTe supports:

• API Key authentication for all Discover API access

  Each request must include a valid API key. Requests without a valid key will not be processed.

How API Keys Work

• An API key is generated when your organization is set up in SMARTe
• The key is scoped to your organization
• The same API key can be used across all SMARTe APIs, including Discover APIs

Using an API Key

Include the API key in the request header:

apikey: YOUR_API_KEY

Example Request Header

{
  "apikey": "your_api_key_here",
  "Content-Type": "application/json"
}

The API key must be included in every request.

API Key Security

• Store API keys securely using environment variables or a secure vault
• Do not expose API keys in client-side applications
• Do not commit API keys to public repositories

💡

API keys can be rotated or revoked at the organization level. To rotate or regenerate a key, contact your SMARTe administrator or SMARTe Support.