認証

プラットフォーム内のデータは、デフォルトではすべて非公開です。APIにアクセストークンを渡すことで、非公開のデータにアクセスすることができます。

はじめに

Collections はデータベース内のデータを管理するために、REST の API を提供しています。API は、標準的な HTTP ステータスコードに依存し、入出力には JSON を使用します。

アクセストークン

Collections の認証に使用できるトークンは2種類あります。

一時トークン (JWT) は、ログインエンドポイントによって token として返されます。これらのトークンは有効期限が比較的短く、最も安全に使用できます。 refreshToken は token とともに返され、リフレッシュエンドポイントによって新しいトークンを取得するために使用できます。

APIキー は、プラットフォーム・ユーザーごとに設定でき、有効期限はありません。安全性は低いですが、サーバ間通信には非常に便利です。APIキーは CollectionsUsers.apiKey にプレーンテキストで保存されます。

アクセストークンを取得したら、access_token クエリパラメータか、リクエストの Authorization ヘッダに記述して API に渡します。

クエリパラメータ

?access_token=<token>

Authorization ヘッダ

Authorization: Bearer <token>