認証 - Tiro Docs

API Keys

Tiro APIは認証にAPI keyを使用します。すべてのAPIリクエストには、Bearer token形式を用いて、Authorizationヘッダーに有効なAPI keyを含める必要があります。

API keyは安全に保管し、クライアントサイドのコードに公開しないでください。API keyはサーバーサイドのアプリケーションでのみ使用してください。

Tiro APIのkeyは次の形式に従います。

{id}.{secret}

例: abc123.xR7mK9pL2qW4...

Part	Example	Description
Key ID (`{id}`)	`abc123`	Platformダッシュボードに表示されます。どのkeyがリクエストを行っているかを識別するために使用します。
Secret (`{secret}`)	`xR7mK9pL2qW4...`	作成時に一度だけ表示されます。サーバーはhashのみを保存するため、復元できません。
Full API Key	`abc123.xR7mK9pL2qW4...`	ドットを含む文字列全体です。これをBearer tokenとして使用します。

よくある間違い: Key ID（abc123）だけをBearer tokenとして使用しないでください。full key（abc123.xR7mK9pL2qW4...）、つまりkey作成時に表示された完全な文字列を使用する必要があります。

すべてのリクエストのAuthorizationヘッダーにAPI keyを含めます。

curl -H "Authorization: Bearer $TIRO_API_KEY" \
     -H "Content-Type: application/json" \
     https://api.tiro.ooo/v1/external/notes

認証に失敗すると、401 Unauthorizedレスポンスが返されます。主な原因は次のとおりです。

{
  "error": {
    "code": "invalid_api_key",
    "message": "The API key provided is invalid",
    "type": "authentication_error"
  }
}

環境変数を使用して、API keyを安全に保管します。

# .env file (never commit this!)
TIRO_API_KEY=abc123.XYZ...