Skip to main content

Authentication

All API requests must be authenticated using an API key.

API Key Authentication

Include your API key in the X-API-Key header with every request:

curl -X GET https://api.transformify.mk/api/v1/templates \
-H "X-API-Key: om_your-api-key-here"

Getting Your API Key

  1. Log in to the Transformify Dashboard
  2. Navigate to Account → API & Integrations
  3. Click Generate API Key
  4. Copy and securely store your key

Your API key starts with om_ followed by 32 characters (e.g., om_a1B2c3D4e5F6g7H8i9J0...). The key is displayed only once at creation time. Generating a new key automatically revokes the previous one.

warning

Keep your API key secure. Never expose it in client-side code or public repositories. If your key is compromised, regenerate a new one immediately from the dashboard.

Error Responses

Missing API Key

If you don't include an API key, you'll receive a 401 Unauthorized response:

{
"error": "Unauthorized",
"message": "Missing or invalid X-API-Key header. Please provide a valid API key."
}

Invalid API Key

If your API key is invalid or revoked:

{
"error": "Unauthorized",
"message": "Invalid or revoked API key. Please check your credentials."
}

Account Not Fully Set Up

If your company account has not been fully set up yet, you'll receive a 503 Service Unavailable response:

{
"error": "Service Unavailable",
"message": "Your account is not fully set up yet. Please contact support."
}

Solution: Contact support to complete your account setup.

Code Examples

curl -X GET https://api.transformify.mk/api/v1/templates \
-H "X-API-Key: om_your-api-key-here"

Best Practices

  1. Use environment variables - Store your API key in environment variables, not in code
  2. Rotate keys regularly - Generate new keys periodically for security
  3. Monitor usage - Check the dashboard for unusual API activity