FLAM API連携機能

機能概要

本機能は、FLAMのデータをAPI経由で外部のシステムやツールに連携する機能です。
連携先のシステム・ツールの設定やプログラムは、お客様（または開発をご依頼される事業者様）にてご用意いただきます。

現在取得できるデータ

連携のしくみ

ご利用条件

ご利用開始までの流れ

1. お申込み FLAMの画面右上の人形マーク > 「ご契約情報」を開き、「オプション契約」の〔変更する〕からお申し込みください（FLAMご契約情報 操作手順 > 契約内容を変更する を参照）。
2. 当社にてAPI連携を有効化（お客様の作業は不要） ご契約内容を確認のうえ、当社にてAPI連携を有効化し、完了をご連絡いたします。
3. 連携先の準備 連携先のシステム・ツールで、FLAMへの登録に必要な情報（リダイレクトURIなど）を確認します。
4. FLAMにアプリを登録 FLAMで連携先ごとにアプリを登録し、Client IDとClient Secretを発行します。詳しくは「アプリの登録」をご覧ください。
5. 接続を承認（「担当者が承認して使う」場合のみ） 連携先からFLAMに接続し、同意画面で承認します。詳しくは「接続の承認」をご覧ください。

連携方法とClient Secretの選び方

アプリの登録画面では「連携方法」と「Client Secret」の2つを選択します。連携先に合わせて、以下の組み合わせからお選びください。

連携方法

データを取り出すときに、誰の権限を使うかを選択します。

• 担当者が承認して使う：アプリを使う担当者様がFLAMの同意画面で承認し、その担当者様の権限でデータを取得します。担当者様によって取得できるデータの範囲が異なります。
• システムが自動で使う：担当者様の承認を介さず、アプリに設定した権限でデータを取得します。人が操作しなくても動く連携に向いています。

Client Secret

連携先のシステム・ツールがClient Secretを使うかどうかで決まります。連携先の設定画面にClient Secretの入力欄があれば「発行する」、なければ「発行しない」を選択してください。

アプリの登録

FLAMに管理者権限の担当者でログインし、連携先ごとにアプリを登録します。

1. API連携アプリ一覧を開く メインメニュー ＞ その他 ＞ 外部サービス連携 ＞ API連携アプリ一覧 に移動します。
2. 「新規」をクリック 画面右上の「新規」をクリックします。

3. 必要事項を入力 下表を参考に入力します。

   

4. 利用規約に同意して登録 「FLAM API利用規約」の内容をご確認のうえ「同意する」にチェックし、〔登録〕をクリックします。

5. Client IDとClient Secretを控える 登録が完了すると、Client IDとClient Secretが表示されます。両方を控え、連携先のシステム・ツールに設定してください。「全項目をコピー」をクリックすると、連携先に設定する値をまとめてコピーできます。

   

入力項目

接続の承認

「担当者が承認して使う」の場合

連携先のシステム・ツールでFLAMへの接続を開始すると、FLAMの同意画面が表示されます。アプリ名と許可する操作を確認して承認すると、接続が完了します。2回目以降は、同意画面を経由せずにデータを取得できます。

「システムが自動で使う」の場合

同意画面は表示されません。アプリ登録時に設定したAPI利用権限に基づいて動作します。同意画面が表示されないのは正常な動作です。

登録したアプリの管理

登録したアプリは、メインメニュー > その他 > 外部サービス連携 > API連携アプリ一覧 から確認・編集できます。

API利用権限の変更

アプリの編集画面でAPI利用権限のチェックを外して保存すると、そのアプリからは該当のAPIをただちに利用できなくなります。

Client Secretの再発行

Client Secretを紛失した場合や、第三者に知られたおそれがある場合は再発行してください。再発行すると、以前のClient Secretは使用できなくなります。手順は「API連携のClient Secretを紛失した・漏えいした」をご覧ください。

アプリの削除

不要になったアプリは削除できます。削除したアプリを使った連携は動作しなくなります。

開発を外部に委託する場合

連携先のプログラムの作成や設定を、システム開発事業者様などに委託いただくことができます。その場合は以下にご注意ください。

• 委託先様によるAPIの利用は、ご契約者様によるご利用として取り扱います。
• Client IDとClient Secretを委託先様にお渡しになる場合は、ご契約者様の責任で管理してください。
• API仕様書を委託先様にご覧いただく場合は、事前に委託先様についての閲覧申請が必要です。
• 当社へのお問い合わせ・ご依頼は、ご契約者様からお願いいたします。特に、Client Secretの再発行やAPI連携の有効化・解除などのご依頼は、ご契約者様からのみ承ります。

詳しくは「FLAM API利用規約」第6条・第10条をご覧ください。

制限事項・対象範囲

当社からのご連絡

ご登録いただいた技術関連窓口用メールアドレスに個別にご連絡するのは、次の場合に限ります。

• APIに障害が発生した場合
• すでに稼働している連携が動作しなくなる仕様変更（項目の削除、応答形式の変更、機能の廃止など）を行う場合

項目や機能の追加など、上記に当たらない変更は、API仕様書の更新履歴への掲載をもってお知らせに代えます。

うまく接続できない場合

{"error":{"code":"feature_disabled","message":"..."}}

上記で解決しない場合は、エラー画面全体のスクリーンショットと、アプリのClient IDを添えてFLAMカスタマーサービスセンターまでお問い合わせください。Client Secretは記載しないでください。
お問い合わせの方法

よくある質問