Custom API Action（カスタムAPIアクション）
Evident ID Verify APIまたはSubmit APIに対してカスタムAPI呼び出しを行います。
このカードがサポートするのは本稼働APIのみです。サンドボックスAPI（デモAPIとも呼ばれます）はサポートされません。
オプション
| フィールド | 定義 | タイプ | 必須 |
|---|---|---|---|
|
API |
クエリする適切なAPI（Verify またはSubmit）を選択します。 |
ドロップダウン |
正 |
|
Request Type（リクエストタイプ） |
これはカスタムAPI呼び出しでサポートされる以下のいずれかのHTTPリクエストメソッド、つまりHTTP動詞です（「HTTPリクエストメソッド」を参照）。
|
ドロップダウン |
TRUE |
入力
| フィールド | 定義 | タイプ | 必須 |
|---|---|---|---|
|
ユーザー |
|||
|
Relative URL（相対URL） |
呼び出すWebサーバーのURLアドレス。/{insert_remaining_URL}のように相対URLを指定します。 「?」を使用して相対URL内にクエリパラメーターを指定したり、［Query（クエリ）］入力内のキーと値のペアとしてクエリパラメーターを指定したりすることができます。 たとえば、Evident ID APIエンドポイントの場合：
Evident ID APIのドキュメントを参照してください。 |
テキスト |
TRUE |
|
Query（クエリ） |
キー/値のペアとして含める必要がある追加のクエリパラメーターを指定します。 例：{"name":"something-urgent"}。 |
オブジェクト |
FALSE |
|
Headers（ヘッダー） |
認可またはコンテンツタイプ（これらのヘッダーにはすでにコネクターが対応しています）以外に必要な任意のヘッダーを指定します。 |
オブジェクト |
FALSE |
|
Body（本文） |
リクエストボディーをJSON形式で指定します。 この入力は、POST、PUT、PATCHリクエストでのみ使用できます。 |
オブジェクト |
FALSE |
出力
| フィールド | 定義 | タイプ |
|---|---|---|
|
Response （レスポンス） |
||
|
Status Code（ステータスコード） |
操作の結果。コネクターは、カードによって実行されたアクションの成否を示すHTTPステータスコードを返します。例：
発生する可能性があるステータスコードの完全なリストについては、「HTTPステータスコード」を参照してください。 |
数値 |
|
Headers（ヘッダー） |
出力ボディーとは関係のない、ステータスコードの詳細なコンテキスト。レスポンスヘッダーは、選択したHTTPリクエストオプションによって決定します。すべてのヘッダーがレスポンスヘッダーというわけではありません。これは、{"Content-type":"application/json"}のようになります。 |
オブジェクト |
|
Body（本文） |
選択したHTTPリクエストから返されたデータ。 たとえば、GETリクエストからのデータ。 |
オブジェクト |
Verify APIを呼び出して新しいリクエストを作成する
-
［API］ドロップダウンメニューで［Verify］を選択します。
-
［Request Type（リクエストタイプ）］ドロップダウンメニューで［POST］を選択し、［Save（保存）］をクリックします。
-
すべてのリクエスト入力を選択し、［Save（保存）］をクリックします。
-
［Relative URL（相対URL）］フィールドに/verify/requestsと入力します。
-
［Body（本文）］フィールドにリクエストを入力します。たとえば、次の入力は運転免許証のデータを要求します。
{
"description": "Upload license",
"email": "output@example.com",
"attributesRequested":
[
{"attributeType": "core.firstname"},
{"attributeType": "core.lastname"},
{"attributeType": "core.address.fulladdress"},
{"attributeType": "identity_assurance.document_verification.americas.us.verification_status"}
]
}APIは、IDが含まれる［Body（本文）］を返します。次のリクエストでそのIDを使用します。
userIdentityTokenを取得する
-
［API］ドロップダウンメニューで［Verify］を選択します。
-
［Request Type（リクエストタイプ）］ドロップダウンメニューで［GET］を選択し、［Save（保存）］をクリックします。
-
［Relative URL（相対URL）］フィールドに/verify/requests/{id}/authTokenに類似する値を入力します。
このステップでユーザーのベアラートークンとリクエストのIDを取得できます。べアラートークンを使用することで、データを送信するためのSubmit APIを呼び出すことができます。
Submit APIを呼び出してデータを送信する
-
［API］ドロップダウンメニューで［Submit］を選択します。
-
［Request Type（リクエストタイプ）］ドロップダウンメニューで［POST］を選択し、［Save（保存）］をクリックします。
-
［Body（本文）］フィールドに入力を追加します。次に例を示します。
{
"Request:":
{
"Relative URL": "/requests",
"metadata": "getHttpInputs",
"config": "",
"Headers":
{
"Accept": "application/json",
"Content-Type": "application/json",
"Authorization": "Bearer <bearer token obfuscated>"
},
"Body":
{
"inputs":
[
{
"type": "core.firstname",
"value": "Workflows"
},
{
"type": "core.lastname",
"value": "Test"
},
{
"type": "certifications.servsafe.servsafe_food_handler.certnumber",
"value": "1234567"
}
]
}
}
}［Relative URL（相対URL）］および［Headers（ヘッダー）］フィールドの値に注意してください。
Submit APIでは、以前のステップで取得したユーザーのベアラートークンを使ってデータを送信できます。