API連携（外部データ取得API）の使い方

外部のSFA・ダッシュボードアプリなどから、AoiroADに登録したデータを取得できるオプション機能です。月額プランとは別の追加契約が必要で、管理者専用の「ユーザー管理」画面から申し込み・設定を行います。

料金と契約条件

月額プランにまだお申し込みでない場合は、先に月額プランのお申し込みが必要です。「ユーザー管理」画面のAPI連携ブロックにその旨が案内され、お申し込みボタンは表示されません。

お申し込み方法

「ユーザー管理」画面（管理者のみ）の「🔑 API連携」ブロックにある「🔑 API連携に申し込む」ボタンを押すと、Stripe（決済代行会社）の安全な決済ページに移動します。カード情報を入力して登録が完了すると、AoiroAD側に自動で反映されます（反映まで数秒かかる場合があります）。

お支払い方法の変更・請求書のダウンロード・解約は、月額プランと同じ「お支払い方法・請求書を管理」ボタンからまとめて行えます。

APIキーを発行する

お申し込み後、同じ「API連携」ブロックに表示される「🔑 APIキーを発行する」ボタンからAPIキーを発行できます。発行されたキーはその場で一度だけ表示され、以後は再表示できないため、必ずその場で控えてください。

キーを控え忘れた場合や、キーが漏洩した可能性がある場合は「🔄 APIキーを再発行」ボタンで新しいキーを発行してください。
再発行すると古いキーはすぐに使えなくなります。

APIの使い方

発行したAPIキーは、リクエストのAuthorizationヘッダーにBearer形式で指定します。用意されているエンドポイントは次の2つです。

そのままコピーして実行できるcurl・PowerShellの具体例は、下記「デモ環境で試す」で紹介しています。
ご自身のテナントで利用する場合は、例の中のAPIキーとURLを、ご自身で発行したキー・テナントURLに置き換えてください。

APIは読み取り専用で、データを書き換えるエンドポイントはありません。

デモ環境で試す

デモ環境（https://app.aoiroad.com/aoiroad/）では、実際のお申し込みなしに、誰でも同じ共有APIキーを使ってこの機能の動作を確認できます。ログイン後の「ユーザー管理」画面のAPI連携ブロックにも、同じ共有キーが表示されます。

このキーはデモ環境のデータしか取得できないため、実際の運用データには使用できません。ご自身のテナントで利用する場合は、上記の「お申し込み方法」からAPI連携に申し込み、個別にAPIキーを発行してください。

アプリ一覧を取得する（get_apps.php）

curlの実行例：

curl -H "Authorization: Bearer ak_2cecfa7fd66157d3559be914ac773c9916b0647bf033c5ec" "https://app.aoiroad.com/aoiroad/api/get_apps.php"

PowerShellの実行例（curlはInvoke-WebRequestのエイリアスのため、Invoke-RestMethodを使用してください）：

Invoke-RestMethod -Uri "https://app.aoiroad.com/aoiroad/api/get_apps.php" -Headers @{ Authorization = "Bearer ak_2cecfa7fd66157d3559be914ac773c9916b0647bf033c5ec" }

レコードを取得する（get_records.php）

app_idは上記get_apps.phpのレスポンスで確認できるIDに置き換えてください。sinceには差分取得の基準日時を指定します。

curlの実行例：

curl -H "Authorization: Bearer ak_2cecfa7fd66157d3559be914ac773c9916b0647bf033c5ec" "https://app.aoiroad.com/aoiroad/api/get_records.php?app_id={app_id}&since=YYYY-MM-DD"

PowerShellの実行例：

Invoke-RestMethod -Uri "https://app.aoiroad.com/aoiroad/api/get_records.php?app_id={app_id}&since=YYYY-MM-DD" -Headers @{ Authorization = "Bearer ak_2cecfa7fd66157d3559be914ac773c9916b0647bf033c5ec" }

サポート窓口

API連携に関するお問い合わせはメールのみで承っております。aoiroad@aoiroad.com までご連絡ください。

よくある質問

Q. 月額プランを解約すると、API連携も一緒に解約されますか？
A. はい。月額プランを解約すると、API連携アドオンをご契約中の場合はあわせて自動的に解約されます。逆に、API連携だけを解約しても月額プランは解約されません。

Q. APIキーを忘れてしまいました。確認できますか？
A. 発行時にその場で一度だけ表示される仕様のため、後から同じキーを確認することはできません。「🔄 APIキーを再発行」から新しいキーを発行してください。

Q. 削除したレコードもAPIで取得できますか？
A. 削除された内容そのものは取得できません。get_records.phpにsinceパラメータを指定して差分取得すると、指定日時以降に削除されたレコードはrecord_idとis_deleted:trueのみが返り、「削除された」という通知だけを受け取れます。

Q. 一般ユーザーもAPIキーを発行・確認できますか？
A. いいえ、APIキーの発行・再発行・お申し込みはすべて管理者専用の操作です。