API機能
API機能とは
本APIは、パレットCMSが提供するデータを外部のアプリケーションやプログラムから扱うための機能を提供するインターフェースです。
APIでのデータ登録や編集、取得した情報を利用し、外部システムと連携した新しいサービスが展開できます。
各APIにおけるリクエスト、レスポンスなど詳細は、別途、仕様書を用意しています。
製品サイトお問い合わせフォーム より、お問い合わせください。
認証方式
APIのリクエストを実行するには、認証のためのヘッダを追加します。
トークン認証
APIの利用に際し、OAuthアクセストークンで認証を行います。
管理者のアカウント詳細画面よりAPIキー（アクセスキー、シークレットキー）を取得し、リクエストヘッダに設定します。※シークレットキーは管理画面より再発行が可能。
マネージャー権限のAPIキーは、管理者権限：マネージャー詳細画面より取得してください。
リクエストヘッダの書式
- X-Auth-Token アクセスキー:シークレットキー ※コロンで結合
セッション認証
一般、ユーザー権限からAPIを実行する場合は、セッションによる認証を利用できます。
※セッションは権限単位で管理されます。
ロールとアクセス権限
管理者はロールを使⽤して、各アカウントに操作権限を割り当てることができます。APIを利用する各権限に、操作権限が許可されていることが前提になります。
| ロール | 管理者／マネージャー／ユーザー／一般 |
|---|---|
| アクション | 登録／一覧／参照／詳細／編集／削除 |
アクセス権限の設定は、管理画面：設定 > シート設定 | アクセス権限 より行います。
任意項目のAPI制御
取得API（1件、複数件、集計値）は、任意項目の設定でAPIへのリクエスト権限が許可されている必要があります。
設定は、項目情報 > 権限設定より行います。
許可されていない（チェックが外されている）項目は、APIによる取得ができません。※登録は可。
対象データと操作
HTTP通信を利用し、RESTful APIのガイドラインに沿って設計されています。リクエストURIに要求された情報を付与し、該当データをJSON形式で返却します。
| 対象データ | API | HTTPメソッド |
|---|---|---|
| user | 登録 | POST |
| 取得（複数件、1件、集計値） | GET | |
| 編集 | PUT | |
| 削除 | DELETE | |
| manager | 取得（複数件、1件、集計値） | GET |
| item | 登録 | POST |
| 取得（複数件、1件、集計値） | GET | |
| 編集 | PUT | |
| 削除 | DELETE | |
| entry | 登録 | POST |
| 取得（複数件、1件、集計値） | GET | |
| 編集 | PUT | |
| 削除 | DELETE | |
| form | 登録 | POST |
| 取得（複数件、1件、集計値） | GET | |
| 編集 | PUT | |
| 削除 | DELETE | |
| review | 登録 | POST |
| 取得（複数件、1件、集計値） | GET | |
| 編集 | PUT | |
| 削除 | DELETE | |
| point | 登録 | POST |
| 取得（複数件、1件、集計値） | GET | |
| 編集 | PUT | |
| pay | 注文情報取得（複数件、1件） | GET |
| pay_history | 決済情報取得（複数件、1件） | GET |
| 決済のステータス変更 | PUT | |
| log | 登録 | POST |
| 取得（複数件、1件） | GET | |
| フィールド | 取得（複数件） | GET |
| ステータス | 取得（複数件） | GET |
| 対象データ | API | HTTPメソッド |
|---|---|---|
| user | 取得（複数件、1件、集計値） | GET |
| manager | 取得（1件） | GET |
| item | 登録 | POST |
| 取得（1件、複数件、集計値） | GET | |
| 編集 | PUT | |
| 削除 | DELETE | |
| entry | 取得（複数件、1件、集計値） | GET |
| form | 取得（複数件、1件、集計値） | GET |
| review | 登録 | POST |
| 取得（複数件、1件、集計値） | GET | |
| log | 登録 | POST |
マネージャー権限で取得できるデータには一部制限があります。主な制限内容、対象情報は以下になります。
※任意項目のAPI制御で許可されている項目が対象。
| 対象データ | 主な制限内容 / 対象情報 |
|---|---|
| user | ・固定項目の出力制限あり。 ・任意項目は、項目の権限設定 | API表示 で管理者が許可した情報のみ。 |
| manager | ・固定項目の出力制限あり。 ・任意項目は、項目の権限設定 | API表示 で管理者が許可した情報のみ。 ・自己のレコードのみ参照可能。 |
| item | ・固定項目の出力制限あり。 ・任意項目は、項目の権限設定 | API表示 で管理者が許可した情報のみ。 ・自身が所有するアイテムレコードのみ参照可能。 |
| entry | ・固定項目の出力制限あり。 ・任意項目は、項目の権限設定 | API表示 で管理者が許可した情報のみ。 ・自身が所有するアイテムにエントリーされたレコードのみ参照可能。 |
| form | ・固定項目の出力制限あり。 ・任意項目は、項目の権限設定 | API表示 で管理者が許可した情報のみ。 ・自身に対してフォーム送信されたレコード。 |
| review | ・固定項目の出力制限あり。 ・任意項目は、項目の権限設定 | API表示 で管理者が許可した情報のみ。 ・自身に対してレビューされたレコード（マネージャーレビュー）。 ・自身が所有するアイテムに対してレビューされたレコード（アイテムレビュー）。 ・自身がレビューしたレコード（マネージャー・アイテムレビュー）。 |
| 対象データ | API | HTTPメソッド |
|---|---|---|
| user | 登録 | POST |
| 取得（1件） | GET | |
| 編集 | PUT | |
| 退会 | PUT | |
| パスワード変更 | PUT | |
| item | 取得（複数件、1件、集計値） | GET |
| form | 登録 | POST |
| 取得（1件） | GET | |
| point | 取得（1件） | GET |
| pay | カード情報取得（複数件） ※ユーザー自身が使用したカード情報 |
GET |
| log | 登録 | POST |
| 対象データ | API | HTTPメソッド |
|---|---|---|
| user | 登録 | POST |
| パスワード再設定メール送信 | POST | |
| パスワード変更 | PUT | |
| item | 取得（複数件、1件、集計値） | GET |
| form | 登録 | POST |
| log | 登録 | POST |
