Vender Server API
概要
Vender Server API とは、ベンダーのサーバーサイドから呼び出されることを想定したAPIです。
ベンダーに付与されたAPI Secretを用いて認証を行い呼び出します。
ベースURLは以下のとおりです。
https://embed-vender-api.anyflow.jp認証方法
ベンダーサーバーAPI を利用するには、あらかじめ API Secret を発行しておく必要があります。 Secret の設定はこちら
発行したAPI Secret を用いて「アクセストークンを取得する 」のAPIを呼び出すことで、ベンダーサーバーAPIのためのアクセストークンを取得できます。
アクセストークンは Authorization ヘッダーにセットします。
Authorization: Bearer {アクセストークン}認証エラー
認証情報のエラーが発生した際、ステータスコードは 401 になります。認証情報のエラーは原因によって解決可能なものがあります。例えばアクセストークンの有効期限切れです。
有効期限切れのような再度アクセストークンを取得することで解決できる場合、エラーレスポンス内に "recoverable": trueを返します。
{
"messsage": "token expired.",
"detail": {
"recoverable": true
}
}ステータスコード 401 でレスポンス中に recoverable を含んでいない、もしくは false の場合はアクセストークンを再取得しても問題を解決できません。
共通のエラーレスポンス構造
ベンダーサーバーAPI 全体で共通のエラーレスポンスの構造は以下の通りです。
{
message: string | null,
detail: {}
}message
エラー内容が記載されたメッセージです。
トラブルシュート等のためにご利用ください。 メッセージの内容は変更される可能性があるためシステムの制御に利用しないでください。
detail
エラーの原因に関する情報です。
エラーハンドリングをシステム上で行う場合は、この情報を利用してください。
内容は API によって変わります。各種 API のエラーレスポンスをご確認ください。
APIリファレンス
VenderServer API を実行するためのアクセストークンを取得します。
JWTのissの値と同一です。管理画面のJWTの設定画面から取得します
管理画面のAPIシークレットの設定画面から取得します
POST /token HTTP/1.1
Host: embed-vender-api.anyflow.jp
Content-Type: application/json
Accept: */*
Content-Length: 36
{
"vender_id": "text",
"secret": "text"
}200
{"access_token": "string"}Requestトリガーを呼び出すためのソリューションインスタンスを検索し取得します。
該当のソリューションIDです。
デプロイ環境です。指定しない場合は デフォルトの環境 を取得します。
JWTのanyflow_team_idの値と同一です。
JWTのanyflow_user_idの値と同一です。
ワークフローのステータスとしていずれかの値を指定します。
取得対象のページ番号です。指定しない場合は 1 ページ目を取得します。
1 ページあたりの取得件数（最大100件）です。指定しない場合は 100 件分取得します。
GET /solution_instances HTTP/1.1
Host: embed-vender-api.anyflow.jp
Authorization: Bearer accessToken
Accept: */*
200
{
"results": [
{
"id": "string",
"status": "enabled | disabled"
}
]
}RequestTriggerを発火させソリューションを実行します。
ソリューションインスタンス検索APIまたはSDKから取得できます。
ソリューションに設定したリクエストペイロードです。
POST /request_trigger HTTP/1.1
Host: embed-vender-api.anyflow.jp
Authorization: Bearer accessToken
Content-Type: application/json
Accept: */*
Content-Length: 48
{
"solution_instance_id": "text",
"payload": "text"
}{
"job": {
"id": "string",
"state": "succeeded"
},
"payload": {}
}最終更新