ZOLOZ API は言語に依存せず、ゲートウェイ サービスによって公開されます。ZOLOZ API を統合するには、まず ZOLOZ ゲートウェイ サービスと対話できることを確認してください。
始める前に
ゲートウェイサービスは、ゲートウェイプロトコルに基づいて実装されています。詳細については、「ゲートウェイプロトコル 」をご参照ください。ZOLOZ のゲートウェイプロトコルのルールを理解しておいてください。
手順に従ってください。API 認証情報を取得するゲートウェイ サービスとの以降のやり取りに使用する関連 API 認証情報を取得するためです。
タスクについて
ゲートウェイ サービスと対話するには、ゲートウェイ プロトコルを簡単に実装するライブラリを統合するか、ゲートウェイ プロトコルを自分で実装します。
ZOLOZ は、以下のライブラリを提供しています。
Java ライブラリ: プログラミング言語が Java の場合、このライブラリを使用します
このタスクでは、Java ライブラリを使用して ZOLOZ API を統合するためのステップバイステップ ガイドを紹介します。
認証テスト API について
デモとして、このタスクでは認証テスト API を使用します。認証テスト API は、特定の ZOLOZ プロダクトに関連しない特別な API です。これは、認証テストのみを目的として設計されています。有効な JSON オブジェクトを受け入れ、 と同様に、同じ JSON オブジェクトを返します。echo コマンド。
他の API と同様に、認証テスト API もゲートウェイ サービス上に構築されています。つまり、認証テスト API の呼び出しに成功すると、他の API の統合は非常に簡単になります。
手順
ライブラリを使用した ZOLOZ API の統合
Java ライブラリの使用
ZOLOZ Java ライブラリは、Maven 中央リポジトリで公開されています。
次の手順では、公開されている Java ライブラリを使用してゲートウェイ サービスと対話し、API を呼び出す方法を示します。
次の依存関係を POM ファイルに追加して、ライブラリを Maven プロジェクトに導入します。
<dependency> <groupId>com.zoloz.api.sdk</groupId> <artifactId>zoloz-api-sdk</artifactId> <version>1.0.2</version> </dependency>
<dependency>
<groupId>com.zoloz.api.sdk</groupId>
<artifactId>zoloz-api-sdk</artifactId>
<version>1.0.2</version>
</dependency>依存関係の最新バージョンについては、こちら を参照してください。
OpenApiClient クラスをインポートします
import com.zoloz.api.sdk.client.OpenApiClient;
OpenApiClient インスタンスをインスタンス化し、API 認証情報、クライアント ID、ZOLOZ トランザクション公開鍵、およびエンコードされた加盟店トランザクション秘密鍵を使用してインスタンスを構成します。
// 次の変数に適切な値を設定します
String clientId = "<Client ID>";
String zolozPublicKey = "<Base64 でエンコードされた ZOLOZ の公開鍵の内容>";
String merchantPrivateKey = "<Base64 でエンコードされた加盟店の秘密鍵の内容>";
// 署名検証と暗号化の両方がデフォルトで有効になっている OpenApiClient オブジェクトをインスタンス化します
OpenApiClient client = new OpenApiClient();
client.setHostUrl("<ZOLOZ ゲートウェイ URL>");
client.setClientId(clientId);
client.setMerchantPrivateKey(merchantPrivateKey);
client.setOpenApiPublicKey(zolozPublicKey);
// 注: レスポンスの署名検証をスキップする場合は、次の行のコメントを外します
//client.setSigned(false);
// 注: 暗号化を無効にする場合は、次の行のコメントを外します
//client.setEncrypted(false); ZOLOZ ゲートウェイ URL については、「サービス エンドポイントについて」をご参照ください。
API を呼び出します
// 認証テスト API の名前を設定します
String apiName = "v1.aml.analyze";
// リクエストを設定します。単純な JSON オブジェクトです
String request = "{\"bizCode\":\"TEST\",\"extendData\":{\"certName\":\"test\",\"gender\":\"male\",\"nationality\":\"u\"},\"tenantID\":\"TEST\",\"tntInstID\":\"GLOBAL\"}";
// API を呼び出します。レスポンスは、同じ JSON オブジェクトの JSON 文字列であると想定されます
String response = client.callOpenApi(apiName, request);API からレスポンスを受信します
{
// ヒットの詳細
"hitResults":[
{
"reason":"{
"date":"2021/04/01",
// スクリーニング エンジン タイプ
"engineType":"WISE_NEXT_SANCTION",
// 金融関係の暴露者かどうか
"fep":-1,
// ヒット ウォッチリストの ID
"hitId":"FAWC51068",
// 命中タイプ。このフィールドを使用せずに、以下の tag フィールドを使用できます。
"hitType":1,
// スクリーニング一致スコア
"matchRate":100,
// ウォッチリスト プロバイダー
"origin":"DOWJONES",
// エンジン スキャン グループ
"originCategory":"US",
// 入力パラメーター
"paramMatch":"carrie lam",
// 政治的にセンシティブな人物かどうか
"pep":1,
// 一致リストの詳細
"record":{
// 住所情報
"addressList":[
{
"addressCity":"",
"addressCountry":"hk",
"addressLine":"The Peak",
"addressState":""
}
],
// 出生地
"birthPlace":[
{
"name":"Hong Kong"
}
],
// リスト カテゴリ
"category":"POLITICAL INDIVIDUAL",
// 国籍情報
"countryDetails":[
{
"countryType":"Resident of",
"countryValueList":[
{
"code":"hk"
}
]
},
{
"countryType":"Citizenship",
"countryValueList":[
{
"code":"hk"
}
]
}
],
"date":"2021/04/01",
// 生年月日
"dateDetails":[
{
"dateType":"Date of Birth",
"dateValueList":[
{
"day":"13",
"month":"May",
"year":"1957"
}
]
}
],
// 期限切れかどうか
"deceased":"No",
"gender":"Female",
// リスト グループ
"groups":[
"TEST"
],
// リスト ID
"id":"WC51068",
// リスト証明書情報
"idNumberTypes":[
{
"idType":"Passport No.",
"idValueList":[
{
"idNotes":"HONG KONG",
"value":"test"
}
]
}
],
"keywords":[
"OFAC-HK-EO13936",
"OFAC"
],
// 別名
"nameDetails":[
{
"nameType":"Primary Name",
"nameValueList":[
{
"firstName":"test",
"surname":"test",
"titleHonorific":""
}
]
},
{
"nameType":"Also Known As",
"nameValueList":[
{
"firstName":"Yuet Ngor",
"surname":"CHENG"
}
]
},
{
"nameType":"Native Character Name",
"nameValueList":[
{
"language":"zh-CN",
"originalScriptNameList":[
"\xE6\x9E\x97\xE9\x83\x91\xE6\x9C\x88\xE5\xA8\xA5"
]
}
]
}
],
"origin":"WORLDCHECK",
"originId":"51068",
// 役職
"position":"Chief Executive of the Hong Kong Special Administrative Region",
// サブカテゴリ
"subCategory":"PEP N",
"type":"Person"
},
"recordBirthDays":[
"19570513"
],
"recordBirthPlace":"Hong Kong",
// リスト証明書番号
"recordIdentifyNo":"TEST",
// 一致レコード
"recordMatch":"LAM",
"recordNations":[
"hk"
],
"recordResCountries":[
"hk"
],
// エンジン タグ情報
"tag":"GROUP1.PERSON_NAME",
// リスト タイプ Individual: 個人、Company: 会社、Vessel:、Other: その他
"type":"Individual"
}",
// エンジン スキャン パラメーター
"scanArgs":"[{\"groupName\":\"GROUP1\",\"requestArgMap\":{\"PERSON_NAME\":\"Li Yi\"},\"watchlistGroups\":[\"ALL_SANCTION_WATCHLIST\"]}]",
"scanTarget":"NOT_USED",
// エンジン スキャン結果
"scanResult":"review"
}
],
"requestID":"2112121234141151",
"amlDecision":"ACCEPT",
"amlResultCode":"AML_CLEAN"
}リソース
JAR とスクリプト
ライブラリは Github でオープンソースです。ソースコードについては、以下をご覧ください。