Quote3D ドキュメントへようこそ!⏳

認証

Quote3DはAPIトークンを使用してAPIエンドポイントを保護します。外部リクエストは https://api.quote3d.com/v2 から開始し、同じトークンを Authorization: Bearer YOUR_TOKEN_HERE または X-API-Token: YOUR_TOKEN_HERE のいずれかの形式で送信してください。

認証の仕組み

  1. Quote3Dアカウントに登録してログインしてください。
  2. ダッシュボードの「Tokens」タブからAPIトークン(JWT)を生成してください。
  3. APIリクエストにトークンを含めます。Authorization: Bearer がサポートされており、X-API-Token も受け入れられます:
    Authorization: Bearer YOUR_TOKEN_HERE
  4. サーバーはあなたのトークンを検証し、有効で期限切れでない場合、アクセスを許可します。

JWTとは?

Quote3Dのトークンは、ベアラースタイルのAPI認証情報です。クライアントは、トークンを不透明な秘密として扱い、トークンの内部構造に依存しないようにする必要があります。

JWTは3つの部分で構成されます:

  1. ヘッダー:署名アルゴリズムとトークンタイプを指定します。
  2. ペイロード:ユーザーデータとクレーム(ユーザーID、メールアドレス、有効期限など)が含まれます。
  3. 署名:トークンが改ざんされていないことを検証します。

JWTは次のようになります:

<base64url-encoded header>.<base64url-encoded payload>.<base64url-encoded signature>

連携においては、重要なルールは単純です。トークンを安全に保管し、各リクエストで送信し、連携がクライアントサイドのトークンを明示的に必要としない限り、クライアントコードで解析または公開しないようにしてください。

例:トークンの使用方法

curlを使ってトークンを使用する方法は以下の通りです。認証ヘッダーのスタイルは一貫して使用してください。

curl -H "Authorization: Bearer YOUR_TOKEN_HERE" https://api.quote3d.com/v2/user

または、API Playgroundで、認証モーダル(鍵アイコン)にトークンを貼り付けてセッションを認証してください。カスタム統合では、X-API-Tokenヘッダーをより適切に使用することもできます。

トークンは秘密にしてください!パスワードと同様に扱い、共有したり、公開コードリポジトリに公開したりしないでください。