thelogicstudio/experian-businesses-php

Experian Businesses API的非官方PHP SDK

v1.0.4 2024-01-15 02:05 UTC

This package is auto-updated.

Last update: 2024-09-15 03:34:31 UTC


README

Experian的商业信息服务是提供数据和分析洞察的领导者,帮助组织降低风险和提升盈利能力。Businesses API提供了对我们商业数据库的集成访问,该数据库提供了99.9%的美国公司的全面、第三方验证的信息,包括广泛的中小企业数据,行业数据最全面。

 

Businesses API提供了对Experian的商业信用和商业公共记录信息的点菜式访问,包括商业评分、交易、公司关系、破产、抵押品、判决等。

 

一切从搜索开始

商业搜索API允许您输入公司名称、地址、城市和州,以找到其商业识别号(BIN)——您将需要此信息才能从大多数其他API获取数据。主要搜索方法称为“高级搜索”,可以使用我们的匹配可靠性代码进行自动化匹配。次要搜索方法称为“快速搜索”,是一种输入提示式搜索,允许用户使用较少的数据快速找到公司。

SBCS联盟成员可以使用Businesses API的搜索端点。

SBFE联盟成员必须使用SBFE API,使用“类似列表”产品选项搜索公司,或使用名称/地址请求进行自动化匹配。

 

Sandbox中的Businesses API

  • 高级搜索 - 搜索美国公司并返回类似列表的主要方法。旨在自动化和人类交互
  • 快速搜索 - 次要搜索方法。一个灵活的输入提示式搜索API,主要用于人类交互
  • 头部信息 - 商业身份信息。作为独立部分提供,并包含在大多数API响应中
  • 评分 - 商业Intelliscore Plus和财务稳定性风险评分,包括评分、评分因素和月度和季度趋势
  • 评分自动搜索 - 返回Scores API,但包含公司名称和地址请求输入
  • 高级报告JSON - Experian的商业信用报告
  • 高级报告HTML - 使用HTML/CSS渲染的样式高级报告
  • 高级报告PDF - 提供编码的高级报告PDF
  • Intelliscore报告JSON – 仅包含评分的报告
  • Intelliscore报告HTML – 仅包含评分的报告,格式为HTML
  • Intelliscore报告PDF – 仅包含评分的报告,格式为PDF
  • 商业合规洞察JSON – BCI报告有助于客户入职和了解客户调查
  • 商业合规洞察HTML – BCI报告的HTML格式
  • 商业合规洞察PDF – BCI报告的PDF格式
  • 聚合数据 - BizAggs代表超过400个独特的商业信用构建块数据属性
  • 多段 - MultiSegments允许您在单个API调用中请求大多数Businesses API端点的段
  • 风险仪表板 - 包含商业和FSR评分、信用额度金额、当前DBT
  • 业务事实 - 关键运营事实,包括SIC、NAICS、公开状态、销售额、员工人数
  • 欺诈盾牌 - 检测潜在欺诈指标的筛选器。包括可能的OFAC匹配
  • 信用状况 - 关于业务的信用关键事实,包括交易线数量、余额、DBT
  • 法律诉讼和收款摘要 - 所有法律诉讼和收款的摘要
  • 收款 - 摘要和详情
  • 交易 - 交易摘要、支付体验、支付总额和交易支付趋势
  • 破产 - 摘要和详情
  • 抵押权 - 摘要和详情
  • 判决 - 摘要和详情
  • UCC文件 - 摘要和趋势
  • 公司登记 - 包括登记状态的业务公司登记信息
  • 公司关联 - 部分和/或完整家族树
  • 业务联系人 - 个人业主、公司业主、联系人和头衔,以及业务联系
  • 反向地址 - 输入地址并查找与该地址关联的业务
  • 反向电话 - 输入电话号码并查找与该电话号码关联的业务
  • 反向税号 - 输入税号(EIN)并查找与该税号关联的业务
  • 政府详情 – 商业的经济多样性和政府合同数据
  • IST Watch - 使用IST Watch API管理OFAC监管合规和名单筛选

 

企业API环境

 

请注意,开发人员门户沙盒中的企业API是非生产服务,仅用于测试和演示目的。沙盒测试环境中只有少量企业可用。根据您的要求,可以提供有效的企业识别号码(BIN)列表,并且可以使用企业搜索API在沙盒中获取有效的BIN。请联系您的Experian客户经理,讨论获取企业API生产访问权限的事宜。

 

IPv3样本子代码

  • IPv3逻辑回归 - 0586286
  • IPv3机器学习 - 0586548

 

其他开发工具

  • BIS API Postman集合 - 许多BIS API的起始Postman集合和环境
  • BIS HTML资源 - 渲染BIS HTML API报告所需的图像、CSS和JavaScript文件

此PHP包由Swagger Codegen项目自动生成

  • API版本:1.0.2
  • 构建包:io.swagger.codegen.languages.PhpClientCodegen

要求

PHP 5.5及以后版本

安装与使用

Composer

要使用Composer安装绑定,请导航到您的composer.json文件所在位置,然后运行以下命令

composer require thelogicstudio/experian-businesses-php

手动安装

下载文件并包含autoload.php

    require_once('/path/to/SwaggerClient-php/vendor/autoload.php');

测试

要运行单元测试

composer install
./vendor/bin/phpunit

入门

请按照安装过程进行,然后运行以下命令

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

// Configure OAuth2 access token for authorization: OauthSecurity
$config = TheLogicStudio\ExperianBusinessesPHP\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new TheLogicStudio\ExperianBusinessesPHP\Api\BusinessInformationServicesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$body = new \TheLogicStudio\ExperianBusinessesPHP\Model\BusinessAggregatesRequest(); // \TheLogicStudio\ExperianBusinessesPHP\Model\BusinessAggregatesRequest | Business Aggregates Request
$content_type = "application/json"; // string | Content-Type field is to describe the data contained in the body.

try {
    $result = $apiInstance->aggregates($body, $content_type);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BusinessInformationServicesApi->aggregates: ', $e->getMessage(), PHP_EOL;
}

?>

API端点文档

所有URI相对于https://sandbox-us-api.experian.com/businessinformation/businesses

模型文档

授权文档

Oauth安全性

  • 类型: OAuth
  • 流程: 密码
  • 授权URL:
  • 作用域:
  • admin: 管理员作用域

作者

Ian Simpson, The Logic Studio