2. REST API の概要¶

REST API は、モバイルバックエンド基盤の最もプリミティブな API で、HTTPS を用いてモバイルバックエンド基盤サーバの機能を呼び出します。

なお、本文書では REST API の一部の機能についてのみ説明しています。全 API の詳細については「REST API リファレンス」をご参照ください。

2.1. エンドポイント¶

REST API は、以下のエンドポイントに対して発行します。 {server} は、NEC BaaS を運用するサーバホスト名に適宜読み替えてください。

http://{server}/api/1

2.2. テナント, アプリケーションID, アプリケーションキー¶

REST API を発行する際は、テナントIDまたはテナント名、およびアプリケーション毎に発行されたアプリケーションID とアプリケーションキーを送信する必要があります。

テナントIDまたはテナント名は API の URI に埋め込みます。以下の説明では {tenant} として説明しています。

アプリケーションIDとアプリケーションキーは以下のとおり HTTP ヘッダに指定してください。

X-Application-Id ... アプリケーションID
X-Application-Key ... アプリケーションキー

アプリケーションID/アプリケーションキーはデベロッパコンソール上で確認してください。

なお、アプリケーションには「マスターキー」も払い出されます。 X-Application-Key にマスターキーを指定すると、アクセス権限を無視し、すべてのデータにアクセスすることが可能です。マスターキーは管理用にのみ使用してください (セキュリティ上、アプリケーションには埋め込まないでください)。

2.3. セッショントークン¶

一部の API は、ユーザがログインした状態で呼び出す必要があります。ユーザ管理機能の「ログイン」API を呼び出すと、サーバからセッショントークンが払い出されます。この値を以下の HTTP ヘッダに埋め込んで送信してください。

X-Session-Token

2.4. レスポンスフォーマット¶

REST API の呼び出し応答は、通常 JSON オブジェクト形式で返却されます。 Content-Type は "application/json" となります。

2.5. curl を用いた API の呼び出し¶

curl コマンドを用いると、簡単に API を呼び出すことができます。以下に一例を示します。

curl -X GET \
  -H "X-Appliation-Id: {app_id}" \
  -H "X-Appliation-Key: {app_key}" \
  https://{server}/api/1/{tenant}/users