カスタムAPIアクション
Evident ID VerifyまたはSubmit APIに対してカスタムAPI呼び出しを行います。
本稼働APIのみがサポートされています。サンドボックスAPI（デモAPIといいます）はサポートされていません。
オプション
| フィールド | 定義 | タイプ | 必須 |
|---|---|---|---|
| API | 適切なAPIを使用します。VerifyまたはSubmit | ドロップダウン | TRUE |
| Request Type（リクエストタイプ） | これはカスタムAPI呼び出しでサポートされる以下のいずれかのHTTPリクエストメソッド、つまりHTTP動詞です（「HTTPリクエストメソッド」を参照）。
| ドロップダウン | TRUE |
入力
| フィールド | 定義 | タイプ | 必須 |
|---|---|---|---|
| User (ユーザー) | |||
| Relative URL（相対URL） | 対話を試みるWebサーバーのURLアドレス。 たとえば、Evident ID APIエンドポイントであれば、 以下のように指定します。 VerifyProduction:
SubmitProduction: 「Evident ID APIドキュメンテーション」を参照してください。 | 文字列 | FALSE |
| Query (クエリー) | オブジェクト形式（キーと値のペア）で含める必要がある追加のクエリーパラメーターを指定します | オブジェクト | FALSE |
| Headers (ヘッダー) | 認可またはコンテンツタイプ（これらはすでにこのコネクタで処理されている）に加えて必要な任意のヘッダーを指定します | オブジェクト | FALSE |
| Body (ボディー) | リクエストボディーをJSON形式で指定します。POST、PUT、およびPATCHリクエストでのみ使用できます。 | オブジェクト | FALSE |
出力
| フィールド | 定義 | タイプ |
|---|---|---|
| Status Code（ステータスコード） | 操作の結果。HTTPステータスコードはコネクタによって返され、カードによって実行されたアクションが成功したか失敗したかを示します。以下に例を挙げます。
発生する可能性があるステータスコードの完全なリストについては、「 HTTPステータスコード」を参照してください。 | 数値 |
| Headers (ヘッダー) | 出力ボディーとは関係のない、ステータスコードの詳細なコンテキスト。レスポンスヘッダーは選択されたHTTPリクエストオプションに依存します。すべてのヘッダーがレスポンスヘッダーではないことに注意してください。通常、{"Content-type":"application/json"}のようになります。 | オブジェクト |
| Body (ボディー) | 選択されたHTTPリクエストから返されるデータ (たとえば、GETリクエストからのデータなど)。 | オブジェクト |
新規リクエストを作成するためのVerify APIの呼び出し
-
[API (API)]ドロップダウンで、
[Verify (Verify)]を選択します。 -
[Request Type (リクエストタイプ)]ドロップダウンで、
[POST (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を含むボディーを返します。次のリクエストでそのidを使用します。
userIdentityTokenの取得
-
[API (API)]ドロップダウンで、
[Verify (Verify)]を選択します。 -
[Request Type (リクエストタイプ)]ドロップダウンで、
[GET (GET)]を選択し、[Save (保存)]をクリックします。 -
[Relative URL (相対URL)]フィールドに、
/verify/requests/{id}/authTokenと同様のデータを入力します。
このステップでユーザーのベアラートークンとリクエストのidを取得できます。べアラートークンを使用して、データを送信するためのSubmit APIを呼び出すことができます。
データを送信するためのSubmit APIの呼び出し
-
[API (API)]ドロップダウンで、
[Submit (Submit)]を選択します。 -
[Request Type (リクエストタイプ)]ドロップダウンで、
[POST (POST)]を選択し、[Save (保存)]をクリックします。 -
[Body (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では、前のステップで得たユーザーのベアラートークンを使用して、データを送信できます。