aliservice/okapi

v1.0 2024-10-26 03:57 UTC

This package is not auto-updated.

Last update: 2025-03-24 06:58:44 UTC


README

安装依赖

如果已在系统上全局安装 Composer ,请直接在项目目录中运行以下内容来安装 OkApi SDK For PHP 作为依赖项:

composer require aliservice/okapi

一些用户可能由于网络问题无法安装,可以使用阿里云 Composer 全量镜像

快速使用

以查询快递查询接口为例

use aliservice\okapi\Kd;

$api = new Kd("YourApiCode");

$result = $api->search('12345678');

所有的接口服务和方法都支持IDE自动提示和完成(请务必注意方法大小写必须保持一致),基本上不需要文档即可完成接口开发工作,起源开发者平台所有的API调用服务必须设置apiCode值,用于接口调用的身份认证。

ApiCode的值可以在官方服务市场->首页->API服务上方查询到,每个用户账号拥有一个唯一的ApiCode值(请不要随意泄露)。

该SDK服务仅支持官方已经接入的API接口(所有支持的接口都在官方API市场),目前接口数量正在扩充中,你可以联系我们反馈你需要的API接口,我们来统一进行接入。

返回数据

起源开发者平台所有的接口返回数据为JSON格式,通用规范如下:

名称类型说明
codeint返回码,0 表示成功 其它表示失败
messagestring返回提示信息
dataobject返回数据

如果为付费接口,则当code为0的时候计费(免费接口除外),其中data包含的数据请参考具体的接口说明。