プロトコル
HTTPS
フォーマット
JSON
POST,PUT,PATCH,DELETEメソッドを使用する場合HTTPリクエストヘッダーに下記のコンテンツタイプの指定が必要
Content-type:application/json※ GETメソッドはコンテンツタイプの指定は不可
文字コード
UTF-8
URL基本フォーマット
https://api.spiral.place/v1/メソッド
各リソースに対しての取得、作成、変更、削除は、基本的にはリソースのパスとHTTPメソッドを
組み合わせてリクエストを行います。
メソッドの種類
| HTTPメソッド | 説明 |
|---|---|
| GET | リソースの情報を取得します。 |
| POST | リソースを作成します。 |
| PUT | 指定されたリソースの情報を全て差し替えます。 リクエストで指定されなかったフィールドは空で上書きされます。 |
| PATCH | 指定されたリソースの情報を部分的に変更します。 リクエストで指定されなかったフィールドの値は変更されません。 |
| DELETE | 指定されたリソースを削除します。 |
例：
スタッフリストを取得する場合
パラメータ
リソースとメソッドに応じてリクエストURLにパラメータを持つものがあります。パラメータの種類は
以下の2種類です。
パスパラメータ
URLパスの一部に含まれるパラメータ。主にリソースアイテムの特定に使用されます。
GET https://api.spiral-place.com/v1/users/123/
クエリパラメータ
リストの並び順や絞り込み条件などのオプションを指定するのに使用されます。
GET https://api.spiral-place.com/v1/users/?limit=10&offset=30
権限
APIを介したリソースへのアクセスと操作の可否は、アプリがユーザーによって許可されたスコープと
許可したユーザー自身のSPIRAL PLACE上の権限によって決まります。
スコープ
アプリの認証時にユーザーがアプリに対して許可したスコープの範囲内でのみAPIを利用できます。
スコープについては「3.2 スコープ」をご参照ください。
ユーザー権限
アカウントのアドミンにのみ許可された操作は、アプリの利用ユーザーがアドミン権限を持っている
場合にのみ利用できます。
関連リソース
関連リソースとは、あるリソースの属性となるリソースや関連性を持つリソースです。
例：スタッフが参加しているグループ 予定に参加しているスタッフ など
関連リソースは、主となるリソースアイテムのURLに関連リソースを特定する文字列のパスを追加して
アクセスすることができます。
例：
スタッフの関連グループを取得する場合
GET https://api.spiral-place.com/v1/users/123/groups
グループに関連するユーザーを取得する場合：
GET https://api.spiral-place.com/v1/groups/3/users
関連リソースの種類やメソッドはリソースによって異なります。