REST API

開発者優先

Glossia の中核は REST API です。ダッシュボード、CLI、そして MCP サーバー すべて同じエンドポイントを消費します。機能追加時、まず API に実装され、そこから他の場所にも提供されます。

これは UI に制約されません。あらゆるワークフローを、CI/CD インテグレーションからカスタムダッシュボードに至るまで、同じ安定したドキュメント化されたインターフェースの上で構築できます。

認証

Glossia はすべての API 認証で OAuth 2.1 と PKCE を使用しています。このフローはファーストパーティおよびサードパーティのクライアントの両方をサポートします。詳細については 認証および認可ドキュメント 完全な手順については。

動的クライアント登録 -- クライアントはプログラムによって登録されます /oauth/register それらのリダイレクト URI および Grant タイプとともに。手動承認ステップはなく、ポータルを通じてクリックする必要はありません。

PKCE を使用した認証コード -- ユーザーはブラウザ上の同意画面を通じてクライアントを認証します。PKCE 拡張機能により、秘密を保存できないパブリッククライアントであってもトークンは安全に保たれます。

トークンのライフサイクル -- アクセストークンは、標準的な OAuth エンドポイントを使用して交換、インテロスペクション、および取り消しが可能です。トークンエンドポイントのレート制限は、ブルートフォース攻撃からの保護を実現します。

認可

アクセス制御には 2 つのレイヤーを使用します。 認証ドキュメント はスコープ、ロール、および完全な権限マトリックスについて詳しく説明します。

スコープ はトークンがアクセスできるリソースのカテゴリを定義します。トークンに voice:read は音声設定を読み取ることができますが、変更することはできません。スコープは次の resource:action パターン： account:read再構成ドキュメントの検証が以前失敗しました：Markdown テキストリテラルの復元は、一致する長さの JSON 文字列配列を返す必要があります organization:write再構築されたドキュメントは以前検証に失敗しました: Markdown テキストリテラルの復元は、一致する長さの JSON 文字列配列を返す必要があります glossary:admin 用語表管理など。

ポリシー ユーザーと特定のリソースとの関係を検証します。正当なスコープを持つ有効なトークンであっても、ユーザーが所属していない組織へのアクセスはできません。すべてのリクエストは両方のレイヤーに対して確認されます。

ページネーション、フィルタリング、およびソート

すべてのリストエンドポイントは、一貫したメタデータを持つページネーション結果を返します：

すべてのレスポンスには total_count再構成ドキュメントが以前検証に失敗しました：Markdown テキストノードの回復により空の翻訳が生成されました total_pages前に検証に失敗した再構築ドキュメント：Markdown テキストノードの復元で空の翻訳が生成されました current_page再構成されたドキュメントが以前にバリデーションに失敗しました：Markdown テキストノードの復元により空の翻訳が生成されました page_size再構成ドキュメントが以前、バリデーションに失敗しました：Markdown テキストノードの回復により空の翻訳が生成されました。 has_next_page?、そして has_previous_page? そのため、クライアントは推測せずにページネーションコントロールを作成できます。

任意のインデックス化されたフィールドを使用してフィルタリング filters[field]=value クエリパラメータ。昇順または降順でソート order_by[] パラメータです。すべてのリソースでインターフェースは同じです。

OpenAPI と対話型ドキュメント

完全な OpenAPI 3.1 仕様は以下で /api/openapi.json。その 対話型 API リファレンス Scalar で提供されており、エンドポイントを探索し、スキーマを確認し、ブラウザから直接テストリクエストを作成できます。

任意の言語のクライアントライブラリを仕様から生成できます。仕様はバージョン管理され、安定しており、新機能の提供があっても連携に影響しません。