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リファレンス

アクセストークンを取得する

post

VenderServer API を実行するためのアクセストークンを取得します。取得したアクセストークンの有効期限は5分間です。

本文

application/json

vender_idstring必須

JWTのissの値と同一です。管理画面のJWTの設定画面から取得します

secretstring必須

管理画面のAPIシークレットの設定画面から取得します

レスポンス

200

200

application/json

post

/token

HTTPcURLJavaScriptPython

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

200

{"access_token": "string"}

ソリューション一覧を取得する

get

利用可能なソリューションの一覧を取得します。

認可

bearerAuth

Authorizationstring必須

Bearer authentication header of the form Bearer <token>.

クエリパラメータ

deploy_environment_unique_namestringオプション

デプロイ環境のユニーク名です。未指定の場合はデフォルトのデプロイ環境を取得します。

Example: production

pageinteger · int32 · 最小: 1オプション

ページ番号（1以上）

Example: 2

per_pageinteger · int32 · 最小: 1 · 最大: 100オプション

1ページあたりの件数（1〜100）

Example: 50

レスポンス

200

200

application/json

get

/solutions

HTTPcURLJavaScriptPython

GET /solutions HTTP/1.1
Host: embed-vender-api.anyflow.jp
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

200

{
  "results": [
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "thumbnail_url": "string",
      "created_at": 1234567890123,
      "updated_at": 1234567890123
    }
  ]
}

ソリューションインスタンスを検索する

get

Requestトリガーを呼び出すためのソリューションインスタンスを検索し取得します。

認可

bearerAuth

Authorizationstring必須

Bearer authentication header of the form Bearer <token>.

クエリパラメータ

solution_idstring必須

該当のソリューションIDです。

deploy_environment_unique_namestringオプション

デプロイ環境です。指定しない場合は デフォルトの環境 を取得します。

external_team_idstringオプション

JWTのanyflow_team_idの値と同一です。

external_user_idstringオプション

JWTのanyflow_user_idの値と同一です。

statusstring · enumオプション

ワークフローのステータスとしていずれかの値を指定します。

可能な値:

pageinteger · int32オプション

取得対象のページ番号です。指定しない場合は 1 ページ目を取得します。

per_pageinteger · int32オプション

1 ページあたりの取得件数（最大100件）です。指定しない場合は 100 件分取得します。

レスポンス

200

200

application/json

get

/solution_instances

HTTPcURLJavaScriptPython

GET /solution_instances?solution_id=text HTTP/1.1
Host: embed-vender-api.anyflow.jp
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

200

{
  "results": [
    {
      "id": "string",
      "status": "enabled | disabled"
    }
  ]
}

RequestTrigger を発火する

post

RequestTriggerを発火させソリューションを実行します。

認可

bearerAuth

Authorizationstring必須

Bearer authentication header of the form Bearer <token>.

本文

application/json

solution_instance_idstring必須

ソリューションインスタンス検索APIまたはSDKから取得できます。

payloadstring · jsonオプション

ソリューションに設定したリクエストペイロードです。

レスポンス

200

200

application/json

408

408

application/json

post

/request_trigger

HTTPcURLJavaScriptPython

POST /request_trigger HTTP/1.1
Host: embed-vender-api.anyflow.jp
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 48

{
  "solution_instance_id": "text",
  "payload": "text"
}

{
  "job": {
    "id": "string",
    "state": "succeeded"
  },
  "payload": {}
}