acomoはヘッドレス志向で設計されているため、全ての操作をAPIで実行できます。全てのAPIはOpen API Specification (version 3)で公開されています。
仕様書を見るには、acomo UIにログインし、サイドメニューの「OpenAPI仕様書」をクリックします。
すると次のような、「acomo API docs」が開きます。Swagger UIで各APIのリクエストパラメーターやレスポンスの形式などを確認できます。
acomo APIでは操作対象や目的ごとにエンドポイントを一定のルールで分類しています。例えば、ワークフロー・プロセスを業務として進めるAPIは、Engine APIと呼ばれています。Open API 仕様書でも「Engine」というグループにまとめられており、またエンドポイントも/api/v1/engineのように分類ごとに用意されています。本文書では、同様にModel APIやProcess APIなどの呼び方を使って、APIグループをまとめて表現します。
Swagger UIでAPIを実際に呼び出してみます。Swagger UIを使うと認証に必要なヘッダーやパラメーターの変更なども簡単に行えて便利です。なお、API呼び出し方法の一連の流れは他のRESTクライアントツールを用いても同じ手順で行えます。
acomoのAPIは原則認証されたユーザーにしか実行を許可していません。そのため、最初にユーザー認証をします。「Auth」の/api/v1/auth/loginというAPIがユーザーログインを行うAPIです。Swagger UI上でAPIを呼び出すには、APIの詳細を開いた状態で「Try it out」ボタンをクリックします。
「Request body」に必要なリクエストパラメーターのサンプルが入力された状態で開きます。ここにacomo UIにログインする際と同じテナントID、メールアドレス、パスワードを入力します。
「Execute」ボタンをクリックすると、実際にAPIにリクエストが発行されます。
正しい認証情報を渡して実行すると、次のようにリクエストが正常に終了します。認証に成功すると「Response Body」の「idToken」が返されるので、この値をコピーします。このIDトークンは、acomoの全てのAPI（ログインAPIを除く）の呼び出し時にリクエストに含める必要があります。このIDトークンを含めることで、呼び出し元のユーザーが認証されていることを検証し、またそのユーザーの権限によって実行することを保証しています。
セキュリティ上、トークン値の一部を隠しています。
acomo APIを呼び出すにあたり、Swagger UI上で認証情報の登録を行います。まず、Swagger UIの上部にある「Authorize」ボタンをクリックします。