SPIRAL ver.2の構築に慣れ、「もっと便利にするカスタマイズを行いたい！」や「外部連携を行いたい！」感じることはありませんか？
APIを活用することで、より柔軟なカスタマイズや外部サービスとの連携が可能になり、SPIRALの活用幅が大きく広がります！
本特集では、APIを利用するための準備から実装・活用方法までをわかりやすくご紹介します。
ぜひご参照ください。

APIは便利ですが、危険で取り扱いが難しいものです。
ナレッジサイトのコンテンツに、サイトを安全に構築・運用するために意識することを記載しております。
セキュリティの向上とAPIを安全に利用してもらうために、ぜひ 安全にAPIを使うために意識すること をご一読ください。

APIキーとは、APIを利用するための認証情報となります。
APIを利用した際に、DBからデータの取得や更新などが行えますので、APIキーという認証があることで、情報の流出などを防いでいます。
APIキーは二種類あり、ユーザのAPIキーとAPIエージェントのAPIキーがあります。

ユーザ・APIエージェントのAPIキーの発行については、下記をご確認ください。

APIエージェントは、グループに所属させることでアクセスできる範囲を制御できます。
グループに所属すると、そのグループに紐づく権限のみが利用可能になります。
権限管理は次の2つの役割で構成されています。

・アプリロール：
　「どのデータに、どんな操作ができるか」を設定する権限セット

・グループ：
　「どのユーザ・APIエージェントをアプリロールに紐づけるか」を管理する枠組み

つまり、アプリロールで「操作権限」を管理し、グループで「誰がその権限を使えるか」を管理します。

APIエージェントを適切なグループに所属させることで、
必要な範囲だけにアクセスさせる安全な運用が可能になります。
設定方法の詳細は、下記をご確認ください。

ナレッジサイトには、動画で実際の画面を見ながら設定を行えるコンテンツを用意しております。
APIエージェントでのAPIキーの発行や、権限設定などについて動画がございますので、ぜひご参照ください。

公式APIリファレンスと
APIのメソッド毎のサンプルコード＆権限設定を纏めた特集がございます。
ぜひご参照ください。
※APIを使用する際には、「APIキー」「アプリロール識別名」「アプリID」「DBID」が必要となります。
　各設定からご確認ください。（全権限の場合には、アプリロール識別名は不要です。）

SPIRAL ver.2には、様々な独自クラス・関数を用意しています。
独自クラスを使用することで、APIで取得したデータをサイトのページ上に表示することや、
サイトにログインしているユーザの認証レコードを取得することなどが可能です。
関数の詳細については、下記をご参照ください。

ナレッジサイトのコンテンツには、スターターデモという業務アプリの工程を分けて、
ポイントやおすすめ機能・強化ガジェットを紹介する記事となっております。
独自クラスやAPI使用したカスタマイズを行っている記事もございますので、ご参照いただけますと幸いです。

ナレッジサイトのコンテンツには、外部サービス連携を特集記事でまとめております。
外部サービスとの連携の際に、SPIRAL APIを使用している記事もございますので、ご参照いただけますと幸いです。