Authentication

このコンテンツはまだ日本語訳がありません。

All protected Eazip API requests require authentication using an API key.

Getting an API Key

Sign in to your Eazip dashboard
Navigate to API Keys in the sidebar
Click Create API Key
Give your key a descriptive name
Copy the key immediately (it won’t be shown again)

Using Your API Key

For direct API access, include your API key in the X-API-Key header:

curl https://api.eazip.io/jobs \
  -H "X-API-Key: YOUR_API_KEY"

Authorization: Bearer ... is used for dashboard session JWTs. The public API examples in this docs site use X-API-Key.

API Key Best Practices

Environment Variables

Store your API key in an environment variable:

export EAZIP_API_KEY="your_api_key_here"

Then use it in your requests:

curl https://api.eazip.io/jobs \
  -H "X-API-Key: $EAZIP_API_KEY"

In Your Code

Node.js:

const response = await fetch('https://api.eazip.io/jobs', {
  headers: {
    'X-API-Key': process.env.EAZIP_API_KEY,
    'Content-Type': 'application/json',
  },
});

Python:

import os
import requests

response = requests.get(
    'https://api.eazip.io/jobs',
    headers={'X-API-Key': os.environ["EAZIP_API_KEY"]}
)

Managing API Keys

You can manage your API keys from the dashboard:

View all active keys
Revoke keys that are no longer needed
Create new keys for different environments

Error Responses

If authentication fails, you’ll receive a 401 Unauthorized response:

{
  "success": false,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Invalid or expired API key"
  }
}

Common causes:

Missing X-API-Key header
Invalid API key
Revoked API key
Expired API key