README

Kimi Nexus 是一个用于公司内部多个项目快速对接第三方 API 的 Composer 库。

目标

统一 API 对接方式（认证、重试、超时、错误处理）
降低新项目接入 API 的重复工作
提供可扩展的集成目录结构

安装（作为库开发）

composer install

安装（在其他项目中使用）

composer require caobowen/kimi-nexus:^0.1

说明：首次发布前可先使用 dev-main。

composer require caobowen/kimi-nexus:dev-main

目录结构

src/Core: 通用能力（配置、HTTP 客户端、异常）
src/Integrations: 各 API 的具体集成实现
tests: 测试目录

快速开始（Business.govt.nz）

<?php

use KimiNexus\Core\ApiConfig;
use KimiNexus\Integrations\BusinessGovtNz\BusinessGovtNzGateway;

$baseUri = getenv('BUSINESS_GOVTNZ_BASE_URI') ?: 'https://api.business.govt.nz/';
$timeout = (float) (getenv('BUSINESS_GOVTNZ_TIMEOUT') ?: 20);
$subscriptionKey = getenv('BUSINESS_GOVTNZ_PRIMARY_KEY') ?: getenv('BUSINESS_GOVTNZ_SECONDARY_KEY');

$config = new ApiConfig($baseUri, null, $timeout, [
    'Ocp-Apim-Subscription-Key' => (string) $subscriptionKey,
]);

$client = BusinessGovtNzGateway::make($config);

// 示例接口：不发真实 HTTP，请求结果固定返回 helloworld
$result = $client->helloWorld();

var_dump($result);

// NZBN 按名称搜索实体
$entities = $client->searchEntitiesByName('acme', [
    'entity_status' => ['Registered', 'VoluntaryAdministration'],
    'entity_type' => ['NZCompany', 'OverseasCompany'],
    'industry_code' => 'M692250',
    'page' => 0,
    'page_size' => 20,
]);

var_dump($entities);

// NZBN 查单个实体详情
$entity = $client->viewEntityByNzbn('9429040000000', [
    'request_id' => '2a444f3f-a486-4f7c-9bcf-e02095fd3576', // 可选，对应 api-business-govt-nz-Request-Id
    'if_none_match' => 'W/"previous-etag"', // 可选，对应 If-None-Match
]);

var_dump($entity);

Business.govt.nz 环境变量

建议在 .env 中配置以下变量。

必填变量：

BUSINESS_GOVTNZ_PRIMARY_KEY=your-primary-key

选填变量：

BUSINESS_GOVTNZ_BASE_URI=https://api.business.govt.nz/
BUSINESS_GOVTNZ_TIMEOUT=20
BUSINESS_GOVTNZ_SECONDARY_KEY=your-secondary-key

说明：

BUSINESS_GOVTNZ_PRIMARY_KEY：首选订阅 key（必填）。
BUSINESS_GOVTNZ_SECONDARY_KEY：主 key 不可用时的回退 key（可选）。
BUSINESS_GOVTNZ_BASE_URI：
- 生产环境：https://api.business.govt.nz/
- Sandbox：https://api.business.govt.nz/sandbox
BUSINESS_GOVTNZ_TIMEOUT：请求超时秒数（默认 20）。
NZBN API 认证关键头是 Ocp-Apim-Subscription-Key。
若你把 key 放在 ApiConfig 第 2 个参数（apiKey）里，BusinessGovtNzGateway 会自动兼容映射到 Ocp-Apim-Subscription-Key。

Business.govt.nz 调用指引

在环境变量中设置 key（至少 BUSINESS_GOVTNZ_PRIMARY_KEY）。
根据环境设置 BUSINESS_GOVTNZ_BASE_URI：
- 生产：https://api.business.govt.nz/
- Sandbox：https://api.business.govt.nz/sandbox
用 BusinessGovtNzGateway::make($config) 创建客户端。
先调用 searchEntitiesByName() 检索 NZBN，再调用 viewEntityByNzbn() 拉实体详情。
若返回 401 missing subscription key，优先检查：
- key 是否为空
- BASE_URI 与 key 所属环境是否匹配（生产 key 对生产地址，sandbox key 对 sandbox 地址）

最小调用示例（搜索 + 详情）：

<?php

use KimiNexus\Core\ApiConfig;
use KimiNexus\Integrations\BusinessGovtNz\BusinessGovtNzGateway;

$baseUri = getenv('BUSINESS_GOVTNZ_BASE_URI') ?: 'https://api.business.govt.nz/';
$timeout = (float) (getenv('BUSINESS_GOVTNZ_TIMEOUT') ?: 20);
$subscriptionKey = getenv('BUSINESS_GOVTNZ_PRIMARY_KEY') ?: getenv('BUSINESS_GOVTNZ_SECONDARY_KEY');

$config = new ApiConfig($baseUri, null, $timeout, [
    'Ocp-Apim-Subscription-Key' => (string) $subscriptionKey,
]);

$client = BusinessGovtNzGateway::make($config);

$entities = $client->searchEntitiesByName('acme', [
    'entity_status' => ['Registered'],
    'page' => 0,
    'page_size' => 5,
]);

$firstNzbn = $entities['data']['items'][0]['nzbn'] ?? null;
if ($firstNzbn !== null) {
    $detail = $client->viewEntityByNzbn($firstNzbn);
    var_dump($detail);
}

已提供的 Business.govt.nz 入口

BusinessGovtNzGateway::make($config): 快速创建客户端入口
BusinessGovtNzApiClient::helloWorld($path = '/helloworld'): HelloWorld 本地示例接口（固定返回）
BusinessGovtNzApiClient::searchEntitiesByName($searchTerm, $filters = []): 调用 GET /{gateway|sandbox}/nzbn/v5/entities 进行实体名称搜索
BusinessGovtNzApiClient::viewEntityByNzbn($nzbn, $options = []): 调用 GET /{gateway|sandbox}/nzbn/v5/entities/{nzbn} 获取实体详情

ABN Lookup（Australia ABR）

可选环境变量示例：

ABN_LOOKUP_BASE_URI=https://abr.business.gov.au/json/
ABN_LOOKUP_GUID=your-abr-guid
ABN_LOOKUP_TIMEOUT=20

说明：ABN_LOOKUP_BASE_URI 建议使用 https://abr.business.gov.au/json/（末尾带 /）。

<?php

use KimiNexus\Core\ApiConfig;
use KimiNexus\Integrations\AbnLookup\AbnLookupGateway;

$baseUri = getenv('ABN_LOOKUP_BASE_URI') ?: 'https://abr.business.gov.au/json/';
$timeout = (float) (getenv('ABN_LOOKUP_TIMEOUT') ?: 20);
$guid = (string) getenv('ABN_LOOKUP_GUID');

$config = new ApiConfig($baseUri, null, $timeout);

$client = AbnLookupGateway::make($config, $guid);

// 1) 按 ABN 查询
$byAbn = $client->searchByAbn('51 824 753 556');

// 2) 按名称模糊查询
$byName = $client->searchByName('COMMONWEALTH BANK', 20, false);

已提供入口：

AbnLookupGateway::make($config, $guid): 创建 ABN Lookup 客户端
AbnLookupApiClient::searchByAbn($abn): 按 ABN 查询
AbnLookupApiClient::searchByName($name, $maxResults = 20, $withDetails = false): 按企业名查询

后续建议

为每个供应商建立独立目录：src/Integrations/{Vendor}
每个集成包含：Client、DTO、Exception
新增统一重试策略、日志追踪（trace id）、熔断与限流

caobowen / kimi-nexus

Maintainers

Package info

Statistics

Security