API機能
API機能とは
本APIは、パレットCMSが提供するデータを外部のアプリケーションやプログラムから扱うための機能を提供するインターフェースです。
APIで取得した情報を利用して、外部システムと連携した新しいサービスを展開できます。
1. APIキーの取得
APIの利用に際し、OAuthアクセストークンで認証を行います。
管理者のアカウント詳細画面よりAPIキー（アクセスキー、シークレットキー）を取得し、リクエストヘッダに設定します。※シークレットキーは管理画面より再発行が可能。
リクエストヘッダの書式
- X-Auth-Token アクセスキー:シークレットキー ※コロンで結合
2. 対象データと操作
HTTP通信を利用し、RESTful APIのガイドラインに沿って設計されています。リクエストURIに要求された情報を付与し、該当データをJSON形式で返却します。
2022年4月現在、APIは以下種類の情報が取得できます。（HTTP：GET方式）
| 対象データ | API | HTTPメソッド |
|---|---|---|
| item | 取得（1件、複数件、集計値） | GET |
| フィールド | 取得（複数件） | GET |
| ステータス | 取得（複数件） | GET |
| entry | 登録 | POST |
| 取得（1件、複数件、集計） | GET | |
| point | 登録 | POST |
| 編集 | PUT | |
| 取得（1件） | GET |
3. 任意項目のAPI制御
取得API（1件、複数件、集計値）は、任意項目の設定でAPIへのリクエスト権限が許可されている必要があります。
設定は、項目情報 > 権限設定より行います。
許可されていない（チェックが外されている）項目は、API取得ができません。※登録は可。
