API機能

API機能とは

本APIは、パレットCMSが提供するデータを外部のアプリケーションやプログラムから扱うための機能を提供するインターフェースです。

APIでのデータ登録や編集、取得した情報を利用し、外部システムと連携した新しいサービスが展開できます。

各APIにおけるリクエスト、レスポンスなど詳細は、別途、仕様書を用意しています。
製品サイトお問い合わせフォーム より、お問い合わせください。

認証方式

APIのリクエストを実行するには、認証のためのヘッダを追加します。

トークン認証

APIの利用に際し、OAuthアクセストークンで認証を行います。

管理者のアカウント詳細画面よりAPIキー（アクセスキー、シークレットキー）を取得し、リクエストヘッダに設定します。※シークレットキーは管理画面より再発行が可能。

マネージャー権限のAPIキーは、管理者権限：マネージャー詳細画面より取得してください。

セッション認証

一般、ユーザー権限からAPIを実行する場合は、セッションによる認証を利用できます。
※セッションは権限単位で管理されます。

ロールとアクセス権限

管理者はロールを使⽤して、各アカウントに操作権限を割り当てることができます。APIを利用する各権限に、操作権限が許可されていることが前提になります。

アクセス権限の設定は、管理画面：設定 > シート設定 | アクセス権限 より行います。

任意項目のAPI制御

取得API（1件、複数件、集計値）は、任意項目の設定でAPIへのリクエスト権限が許可されている必要があります。

設定は、項目情報 > 権限設定より行います。

許可されていない（チェックが外されている）項目は、APIによる取得ができません。※登録は可。

対象データと操作

HTTP通信を利用し、RESTful APIのガイドラインに沿って設計されています。リクエストURIに要求された情報を付与し、該当データをJSON形式で返却します。

マネージャー権限で取得できるデータには一部制限があります。主な制限内容、対象情報は以下になります。
※任意項目のAPI制御で許可されている項目が対象。