カスタムAPIアクション

Evident ID VerifyまたはSubmit APIに対してカスタムAPI呼び出しを行います。

本稼働APIのみがサポートされています。サンドボックスAPI(デモAPIといいます)はサポートされていません。

オプション

フィールド 定義 タイプ 必須
API 適切なAPIを使用します。VerifyまたはSubmit ドロップダウン TRUE
Request Type(リクエストタイプ) これはカスタムAPI呼び出しでサポートされる以下のいずれかのHTTPリクエストメソッド、つまりHTTP動詞です(「HTTPリクエストメソッド」を参照)。
  • GET:パラメーターに基づいてWebサーバーからデータを取得します。このメソッドは指定されたリソースの表現を要求します。リクエストが成功した場合、要求したコンテンツとともに200 (OK)レスポンスメッセージが返されます。
  • POST:パラメーターに基づいてWebサーバーにデータを送信します(ファイルのアップロードなど)。複数のPOSTリクエストは、単一のPOSTとは異なる結果になる場合があります。意図せず複数のPOSTリクエストを送信することを避けるために注意する必要があります。リクエストが成功した場合、200 (OK)レスポンスメッセージが返されます。
  • PUT:パラメーターに基づいて、Webサーバーの特定の場所に格納するデータを送信します (ファイルのアップロードなど)。POSTリクエストとは異なり、PUTリクエストは冪等です。リクエストが成功なら、同じPUTリクエストを何回実行しても、1回実行したときと同じ結果になります。リクエストが成功した場合、200 (OK)201 (Created)、または204 (No Content)レスポンスメッセージを受信します。
  • PATCH:パラメーターに基づいてWebサーバー上のリソースに部分的な変更を適用します。PATCHは冪等ではありません。複数のPATCHリクエストによって意図しない結果が生じる可能性があります。PATCHが成功した場合、200 (OK)または204 (No Content)レスポンスメッセージが返されます。
  • DELETE:パラメーターに基づいてWebサーバーから特定のリソース(存在する場合)を削除します。DELETEが成功した場合、200 (OK)レスポンスメッセージが返されます。
ドロップダウン TRUE

入力

フィールド 定義 タイプ 必須
ユーザー
Relative URL(相対URL) 対話を試みるWebサーバーのURLアドレス。/{insert_remaining_URL}のように相対URLを指定します。「?」を使用して相対URL内にクエリパラメータを指定したり、クエリ入力内のオブジェクトキーペアとしてクエリパラメータを指定したりすることができます。

たとえば、Evident ID APIエンドポイントの場合:

VerifyProduction:

https://verify.api.evidentid.com/api/v1/verify/requestTemplates であれば、相対URLは /verify/requestTemplatesとなります。

SubmitProduction:
https://submit.api.evidentid.com/api/v1/requests であれば、相対URLは/requestsとなります。

Evident ID APIのドキュメントを参照してください。

文字列 TRUE
クエリ オブジェクト形式(キーと値のペア)で含める必要がある追加のクエリーパラメーターを指定します オブジェクト FALSE
Headers(ヘッダー) 認可またはコンテンツタイプ(これらはすでにこのコネクタで処理されている)に加えて必要な任意のヘッダーを指定します オブジェクト FALSE
本文 リクエストボディーをJSON形式で指定します。POSTPUTPATCHリクエストでのみ使用できます。 オブジェクト FALSE

出力

フィールド 定義 タイプ
Response (レスポンス)
Status Code(ステータスコード) 操作の結果。コネクターは、カードによって実行されたアクションが成功したか失敗したかを示す、HTTPステータスコードを返します。例:
  • 201 Createdステータスコードは、アクションが成功し、新しいリソースが作成されたことを示します。
  • 403 Forbiddenエラーは、必要な権限が不足していたためにHTTPリクエストが処理されなかったことを示します。

発生する可能性があるステータスコードの完全なリストについては、「HTTPステータスコード」を参照してください。

数値
ヘッダー 出力ボディーとは関係のない、ステータスコードの詳細なコンテキスト。レスポンスヘッダーは、選択したHTTPリクエストオプションによって決定します。すべてのヘッダーがレスポンスヘッダーというわけではありません。これは、{"Content-type":"application/json"}のようになります。 オブジェクト
本文 選択したHTTPリクエストから返されたデータ。

たとえば、GETリクエストからのデータ。

オブジェクト

新規リクエストを作成するためのVerify APIの呼び出し

  1. [API (API)]ドロップダウンで、[Verify (Verify)]を選択します。

  2. [Request Type (リクエストタイプ)]ドロップダウンで、[POST (POST)]を選択し、[Save(保存)]をクリックします。

  3. すべてのリクエスト入力を選択し、[Save(保存)]をクリックします。

  4. [Relative URL (相対URL)]フィールドに、/verify/requestsと入力します。

  5. [Body (ボディー)]フィールドにリクエストを入力します。たとえば、次の入力は運転免許証のデータを要求します。

Copy
{
"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が含まれる本文を返します。次のリクエストでそのidを使用します。

userIdentityTokenの取得

  1. [API (API)]ドロップダウンで、[Verify (Verify)]を選択します。

  2. [Request Type (リクエストタイプ)]ドロップダウンで、[GET (GET)]を選択し、[Save(保存)]をクリックします。

  3. [Relative URL (相対URL)]フィールドに、/verify/requests/{id}/authTokenと同様のデータを入力します。

このステップでユーザーのベアラートークンとリクエストのidを取得できます。べアラートークンを使用して、データを送信するためのSubmit APIを呼び出すことができます。

データを送信するためのSubmit APIの呼び出し

  1. [API (API)]ドロップダウンで、[Submit (Submit)]を選択します。

  2. [Request Type (リクエストタイプ)]ドロップダウンで、[POST (POST)]を選択し、[Save(保存)]をクリックします。

  3. [Body (Body)]フィールドに入力を追加します。次に例を示します。

Copy
{
"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では、前のステップで得たユーザーのベアラートークンを使用して、データを送信できます。

関連項目

Evident IDコネクター

Workflows要素

Evident ID APIのドキュメント