End User API

概要

End User API とは、エンドユーザーのJWTを使って認証を行い呼び出すAPIです。

My Event を実行するためなどに利用します。

ベースURLは以下のとおりです。

https://for-product-api.anyflow.jp/sdk/

---

APIリファレンス

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

post

My Event 等のエンドユーザーAPIを実行するためのアクセストークンを取得します。

本文

application/json

jwtstring必須

ソリューションを実行したいエンドユーザーを表す JWT を指定します。

envstringオプション

ソリューションを実行したいエンドユーザーの所属するデプロイ環境を指定します。デフォルトのデプロイ環境を使用する場合は指定不要です。

レスポンス

200

200

application/json

access_tokenstringオプションExample: <ACCESS TOKEN>

403

403

application/json

500

500

application/json

post

/token

HTTPcURLJavaScriptPython

POST /sdk/token HTTP/1.1
Host: for-product-api.anyflow.jp
Content-Type: application/json
Accept: */*
Content-Length: 27

{
  "jwt": "text",
  "env": "text"
}

{ "access_token": "<ACCESS TOKEN>" }

My Event にリクエストを送信する

post

My Event にリクエストを送信して、My Event トリガーを発火させます。

認可

bearerAuth

Authorizationstring必須

Bearer authentication header of the form Bearer <token>.

本文

application/json

keystring必須

My Event を識別するためのキーです。管理画面で一意な値を定義します。

payloadstring · json必須

My Event のペイロードです。管理画面で定義したスキーマに沿って記述します。

レスポンス

200

200

application/json

statusstringオプションExample: ok

403

403

application/json

404

404

application/json

500

500

application/json

post

/send_my_event

HTTPcURLJavaScriptPython

POST /sdk/send_my_event HTTP/1.1
Host: for-product-api.anyflow.jp
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 31

{
  "key": "text",
  "payload": "text"
}

{ "status": "ok" }