APIの使用方法
概要
SPIRAL ver.2では各種機能のAPIを公開しております。APIを使用することで外部システムからSPIRALへ連携する等のアプリケーションを作成することが可能になります。
APIを利用するためにはAPIキーが必須となります。
利用可能なAPIの一覧は、「SPIRAL ver.2 APIリファレンス」を参照してください。
APIキーの発行方法
APIエージェントのAPIキーとユーザに紐づくAPIキーの2種類があります。
APIエージェントのAPIキーは、主に外部システムからSPIRALへ連携する際に利用し、ユーザの退職などによる除外に影響することなく、アカウントが直接管理することができます。
ユーザに紐づくAPIキーは、開発ユーザがクライアントシステムの開発/テスト中に使用したり、ユーザ自身のみが扱うクライアントアプリに利用する際に使用します。
発行方法は以下のそれぞれの詳細ページをご参照ください。
リクエストとレスポンス
SPIRAL ver.2のAPIは、REST APIとして実装しております。HTTPSプロトコルとJSONフォーマットで通信します。
APIを使用するには、操作画面から発行するAPIキーを、リクエストヘッダに指定する必要があります。
リクエスト方法
APIサーバのURL
https://api.spiral-platform.com/v1/（以下APIにより異なる）
リクエストパラメータ
以下の認証用のパラメータを必ずリクエストヘッダに指定してください。
- Authorization: Bearer XXXXXXXXX (※発行したAPIキー)
また、POSTとPATCHのメソッドでは、以下のパラメータもリクエストヘッダに指定してください。
- Content-Type: application/json
上記のヘッダ以外のパラメータは、APIによって異なります。
詳細なパラメータについては、SPIRAL ver.2 APIリファレンスを参照してください。