Custom API Action

Evident ID Verify APIまたは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

Query（クエリ）

含める追加のクエリパラメーターをオブジェクト形式（キー/値のペア）で指定します。

オブジェクト

FALSE

Headers（ヘッダー）

承認またはコンテンツタイプ（これらのヘッダーにはすでにカードが対応しています）以外に必要な任意のヘッダーを指定します。

オブジェクト

FALSE

Body（本文）

リクエストボディーをJSON形式で指定します。POST、PUT、PATCHリクエストでのみ使用できます。

オブジェクト

FALSE

出力

フィールド 定義 タイプ

レスポンス

Status Code（ステータスコード）

操作の結果。コネクターは、カードによって実行されたアクションが成功したか失敗したかを示す、HTTPステータスコードを返します。例：

  • 201 Createdステータスコードは、アクションが成功し、新しいリソースが作成されたことを示します。
  • 403 Forbiddenエラーは、必要な権限が不足していたためにHTTPリクエストが処理されなかったことを示します。

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

数値

Headers（ヘッダー）

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

オブジェクト

Body（本文）

選択したHTTPリクエストから返されたデータ。

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

オブジェクト

Verify APIを呼び出して新しいリクエストを作成する

  1. ［API］ドロップダウンメニューで［Verify］を選択します。

  2. ［Request Type（リクエストタイプ）］ドロップダウンメニューで［POST］を選択し、［Save（保存）］をクリックします。

  3. すべてのリクエスト入力を選択し、［Save（保存）］をクリックします。

  4. ［Relative URL（相対URL）］フィールドに/verify/requestsと入力します。

  5. ［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を取得する

  1. ［API］ドロップダウンメニューで［Verify］を選択します。

  2. ［Request Type（リクエストタイプ）］ドロップダウンメニューで［GET］を選択し、［Save（保存）］をクリックします。

  3. ［Relative URL（相対URL）］フィールドに/verify/requests/{id}/authTokenに類似する値を入力します。

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

Submit APIを呼び出してデータを送信する

  1. ［API］ドロップダウンメニューで［Submit］を選択します。

  2. ［Request Type（リクエストタイプ）］ドロップダウンメニューで［POST］を選択し、［Save（保存）］をクリックします。

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

関連項目

Evident IDコネクター

Workflows要素

Evident ID APIのドキュメント