topthink / think-api
Installs: 11 961
Dependents: 0
Suggesters: 0
Security: 0
Stars: 20
Watchers: 2
Forks: 2
Open Issues: 1
Requires
- guzzlehttp/guzzle: ^6.5 || ^7.0
- topthink/think-helper: ^1.0 || ^3.1
Requires (Dev)
- phpunit/phpunit: ^7.0
This package is auto-updated.
Last update: 2024-10-11 07:33:43 UTC
README
ThinkAPI
ThinkAPI
是ThinkPHP
官方推出的统一API
接口服务,提供接口调用服务及开发SDK
,旨在帮助ThinkPHP
开发者更方便的调用官方及第三方的提供的各类API
接口及服务,从而更好的构建开发者生态,详细参考这里。
安装依赖
如果已在系统上全局安装 Composer ,请直接在项目目录中运行以下内容来安装 Think Api SDK For PHP 作为依赖项:
composer require topthink/think-api
一些用户可能由于网络问题无法安装,可以使用阿里云 Composer 全量镜像 。
快速使用
以查询身份证所属地区接口为例
use think\api\Client;
$client = new Client("YourAppCode");
$result = $client->idcardIndex()
->withCardno('身份证号码')
->request();
所有的接口服务和方法都支持IDE自动提示和完成(请务必注意方法大小写必须保持一致),基本上不需要文档即可完成接口开发工作,ThinkAPI
所有的API调用服务必须设置appCode
值,用于接口调用的身份认证。
AppCode
的值可以在官方服务市场->
我的服务->
安全信息里面获取到,每个用户账号拥有一个唯一的AppCode
值(请不要随意泄露)。
该SDK服务仅支持官方已经接入的API接口(所有支持的接口都在官方API市场),目前接口数量正在扩充中,你可以联系我们反馈你需要的API接口,我们来统一进行接入。
返回数据
ThinkAPI
所有的接口返回数据为JSON
格式,通用规范如下:
如果为付费接口,则当
code
为0的时候计费,其中data
包含的数据请参考具体的接口说明。