認証

すべてのAPIリクエストには、認証のためにBearerトークン（APIキー）が必要です。

APIキーの作成

app.ironflock.comでIronFlockにログインします。
ユーザー設定に移動します。
APIキーセクションに移動します。
APIキーを作成をクリックします。
生成されたキーをコピーします。キーは一度しか表示されません。

APIキーの使用

すべてのリクエストのAuthorizationヘッダーにキーを含めてください：


curl -H "Authorization: Bearer YOUR_API_KEY" \
     https://api.ironflock.com/v1/ironflock/devices

Pythonの例


import requests
 
API_KEY = "your-api-key"
BASE_URL = "https://api.ironflock.com/v1/ironflock"
 
headers = {"Authorization": f"Bearer {API_KEY}"}
 
response = requests.get(f"{BASE_URL}/devices", headers=headers)
devices = response.json()

JavaScriptの例


const API_KEY = "your-api-key";
const BASE_URL = "https://api.ironflock.com/v1/ironflock";
 
const response = await fetch(`${BASE_URL}/devices`, {
    headers: { Authorization: `Bearer ${API_KEY}` }
});
const devices = await response.json();

エラーレスポンス

ステータスコード	意味
`401`	APIキーが未設定または無効
`403`	この操作に対する権限が不足
`404`	リソースが見つからない
`422`	バリデーションエラー（リクエストパラメータを確認してください）
`500`	内部サーバーエラー

すべてのエラーレスポンスはJSONオブジェクトを返します：


{
    "error": "Description of the error"
}