テーマ
API利用の概要
このページでは、acomo APIの全体像、製品内で仕様を確認する方法、認証の前提を説明します。画面と自社アプリが同じモデルとプロセスを進める仕組みは 画面とAPI連携 を参照してください。
対象読者
開発者
前提
- acomoにサインインできること
- 開発の「参照」(開発者ツールの表示)があること
知っておくこと
acomoのAPIは REST です。エンドポイントの正式な契約はOpenAPI仕様書にあり、製品内の画面からも参照できます。画面とAPIは同じモデルとプロセスを操作します。
| 導線 | URL(テナント選択後) | 用途 |
|---|---|---|
| 「API」 | /development/apis | 全APIの一覧、Operation ID、必要なシステム実行ポリシー |
| 「OpenAPI仕様書」 | /api | リクエスト/レスポンスのスキーマ、Try it out(本番では参照系に限定。OpenAPI仕様書の注意を参照) |
ブラウザからの操作とAPIは 同じ権限モデル 上で動きます。API一覧の「システム実行ポリシー」列は、呼び出しに必要な権限の目安です(例: Model:read)。
製品内でAPIを確認する手順
- 業務テナントにサインインし、サイドメニューの 開発者ツール を開きます。
- 「API」(
/development/apis)でOperation IDやパスを検索します。 - 行メニューの「仕様を見る」からOpenAPI上の該当操作へ移動します。
- 必要に応じて「CSVダウンロード」で一覧をエクスポートします。
サーバー間連携では アクセストークン の発行と API認証 を先に読んでください。
前提権限
| 操作 | 目安となる権限 |
|---|---|
| API一覧の閲覧 | Development:read |
| モデル一覧の参照 | Model:read |
| プロセス操作 | アクションポリシー、データアクセスポリシー、システム実行ポリシー |
利用前に確認すること
/development/apisにAPI一覧が表示されること- OpenAPIのBearer認証に
AuthorizationとTenant(テナントID)の両方が定義されていること
うまくいかないとき
| 症状 | 確認先 |
|---|---|
| 開発者ツールがメニューにない | メニューと権限、ロールの開発の「参照」 |
| API一覧が403 | 開発の「参照」(Development:read) |
| OpenAPIが開けない | 同一オリジンでのサインインとプロキシ設定 |
詳細は API認証、トラブルシューティング を参照してください。