README

注意！

Trulioo PHP SDK

包版本：1.0.3
API版本：v1
构建包：org.openapitools.codegen.languages.PhpClientCodegen

安装

使用Composer

需要PHP 7.2或更高版本。

在项目的根目录中运行 composer require trulioo/trulioo-sdk，或将此依赖项添加到 composer.json

{
  "require": {
    "trulioo/trulioo-sdk": "^1.0.3"
  }
}

示例应用

请查看sample-app文件夹中的此SDK的示例应用。

入门指南

测试认证示例

require_once(__DIR__ . '/vendor/autoload.php');

use Trulioo\SDK\Configuration;
use Trulioo\SDK\ApiException;
use Trulioo\SDK\Api\ConnectionApi;

$config = Configuration::getDefaultConfiguration()

// Configure API key authorization
$config->setApiKey('x-trulioo-api-key', 'YOUR-X-TRULIOO-API-KEY');

// Configure mode: 'trial' or 'live'
$mode = 'trial';

// Construct instance of ConnectionApi with default HTTP client and config
$connectionApi = new ConnectionApi(null, $config);

// Call ConnectionApi#testAuthentication
try {
    $result = $connectionApi->testAuthentication($mode);
    echo $result;
} catch (ApiException $e) {
    echo "Exception when calling ConnectionApi#testAuthentication\n";
    echo "Status code:      " . $e->getCode() . "\n";
    echo "Reason:           " . $e->getResponseBody() . "\n";
    echo "Response headers: " . json_encode($e->getResponseHeaders()) . "\n";
}

测试

使用Composer运行composer install安装依赖项，然后运行

./run-tests.sh

API文档

所有URI相对于https://gateway.trulioo.com。

类	方法	HTTP请求	描述
BusinessApi	getBusinessSearchResult	GET /{mode}/business/v1/search/transactionrecord/{id}	获取企业搜索结果
BusinessApi	search	POST /{mode}/business/v1/search	搜索
ConfigurationApi	getBusinessRegistrationNumbers	GET /{mode}/configuration/v1/businessregistrationnumbers/{countryCode}/{jurisdictionCode}	获取企业注册号码
ConfigurationApi	getConsents	GET /{mode}/configuration/v1/consents/{configurationName}/{countryCode}	获取同意书
ConfigurationApi	getCountryCodes	GET /{mode}/configuration/v1/countrycodes/{configurationName}	获取国家代码
ConfigurationApi	getCountrySubdivisions	GET /{mode}/configuration/v1/countrysubdivisions/{countryCode}	获取国家次级行政区
ConfigurationApi	getDatasources	GET /{mode}/configuration/v1/datasources/{configurationName}/{countryCode}	获取数据源
ConfigurationApi	getDetailedConsents	GET /{mode}/configuration/v1/detailedConsents/{configurationName}/{countryCode}	获取详细同意书
ConfigurationApi	getDocumentTypes	GET /{mode}/configuration/v1/documentTypes/{countryCode}	获取文件类型
ConfigurationApi	getFields	GET /{mode}/configuration/v1/fields/{configurationName}/{countryCode}	获取字段
ConfigurationApi	getRecommendedFields	GET /{mode}/configuration/v1/recommendedfields/{configurationName}/{countryCode}	获取推荐字段
ConfigurationApi	getTestEntities	GET /{mode}/configuration/v1/testentities/{configurationName}/{countryCode}	获取测试实体
ConnectionApi	connectionAsyncCallbackUrl	POST /{mode}/connection/v1/async-callback	连接异步回调URL
ConnectionApi	sayHello	GET /{mode}/connection/v1/sayhello/{name}	说你好
ConnectionApi	testAuthentication	GET /{mode}/connection/v1/testauthentication	测试认证
VerificationsApi	documentDownload	GET /{mode}/verifications/v1/documentdownload/{transactionRecordId}/{fieldName}	文档下载
VerificationsApi	getTransactionRecord	GET /{mode}/verifications/v1/transactionrecord/{id}	获取交易记录
VerificationsApi	getTransactionRecordAddress	GET /{mode}/verifications/v1/transactionrecord/{id}/withaddress	获取交易记录地址
VerificationsApi	getTransactionRecordDocument	GET /{mode}/verifications/v1/transactionrecord/{transactionRecordID}/{documentField}	获取交易记录文档
VerificationsApi	getTransactionRecordVerbose	GET /{mode}/verifications/v1/transactionrecord/{id}/verbose	获取交易记录详细信息
VerificationsApi	getTransactionStatus	GET /{mode}/verifications/v1/transaction/{id}/status	获取交易状态
VerificationsApi	verify	POST /{mode}/verifications/v1/verify	验证

模型文档

授权文档

ApiKeyAuth

类型: API密钥
API密钥参数名: x-trulioo-api-key
位置: HTTP头部

trulioo / trulioo-sdk

维护者

详细信息

README

注意！

Trulioo PHP SDK

安装

使用Composer

示例应用

入门指南

测试认证示例

测试

API文档

模型文档

授权文档

ApiKeyAuth