API 利用の概要

この章では、認証、クイックスタート、OpenAPI、代表的な連携例までの API 利用を扱います。標準画面と自社アプリが同じモデルとプロセスを進める仕組みは 標準画面と API 連携 を参照してください。

このページでは、acomo API の全体像、製品内で仕様を確認する方法、認証の前提を説明します。

対象読者

開発者

前提

• acomo にサインインできること
• テナントに 開発者権限（開発者ツールの表示）があること

知っておくこと

acomo の API は REST です。エンドポイントの正式な契約は OpenAPI 仕様にあり、製品 UI からも参照できます。標準画面と API は同じモデルとプロセスを操作します。

導線	URL（テナント選択後）	用途
「API」	/development/apis	全 API の一覧、Operation ID、必要なシステム実行ポリシー
「OpenAPI仕様書」	/api	リクエスト／レスポンスのスキーマ、Try it out（本番では参照系に限定。OpenAPI仕様書の注意を参照）

ブラウザからの操作と API は 同じ権限モデル 上で動きます。API 一覧の「システム実行ポリシー」列は、呼び出しに必要な権限の目安です（例: Model : read）。

製品内で API を確認する手順

1. 業務テナントにサインインし、サイドメニューの 開発者ツール を開きます。
2. 「API」（/development/apis）で Operation ID やパスを検索します。
3. 行メニューの「仕様を見る」から OpenAPI 上の該当操作へ移動します。
4. 必要に応じて CSV ダウンロードで一覧をエクスポートします。

サーバー間連携では アクセストークン の発行と API 認証 を先に読んでください。

前提権限

操作	目安となる権限
API 一覧の閲覧	Development : read
モデル一覧の参照	Model : read
プロセス操作	モデルポリシー＋システム実行ポリシー

利用前に確認すること

• /development/apis に API 一覧が表示されること
• OpenAPI の Bearer 認証に Authorization と Tenant（テナント）の両方が定義されていること

うまくいかないとき

症状	確認先
開発者ツールがメニューにない	メニューと権限、ロールの開発者権限
API 一覧が 403	テナントコンテキスト、開発者権限
OpenAPI が開けない	同一オリジンでサインイン済みか、プロキシ設定

詳細は API 認証、トラブルシューティング を参照してください。

次に読む

• API 認証