digiom / api-moysklad
MoySklad API
Requires
- php: >=7.0
- ext-json: *
- digiom/psr7wp: dev-main
This package is auto-updated.
Last update: 2024-09-17 11:40:18 UTC
README
该库旨在方便使用MoySklad API。它包含一组函数,允许对实体进行基本操作(创建、读取、修改、删除)。
入门指南
用于通过SDK进行操作的主要类:Client
要开始使用,需要创建此类的实例,将API主机地址、强制使用https连接的标志以及API访问的登录格式[用户名]@[公司名称]
和密码传递给构造函数
$api = new Client('api.moysklad.ru', true, array('login' => '[API_LOGIN]', 'password' => '[API_PASSWORD]'));
实体操作
使用$api->entity()
方法访问特定实体的端点,该方法返回实体的基本客户端。此对象允许获取用于操作特定实体的客户端。例如,要获取所有供应商的列表,只需执行以下代码
$api->entity()->counterparty()->get();
要向API发送创建实体的请求,只需创建类实例,填写必要字段,然后使用相应的客户端调用post()
方法,并将创建的对象作为参数传递
$product = new Product(); $product->setName('Новый продукт'); $api->entity()->product()->create($product);
执行代码并在成功创建后,对象product
将被API响应中的字段填充(例如id
、href
等)。
要修改已创建的实体,使用实体客户端的update()
方法,其中参数是已更改字段的实体(必须设置id
)或包含更改字段的id
$product->setDescription('Описание продукта'); $api->entity()->product()->update($product);
其他方法的工作方式完全相同。使用实体客户端的特殊方法处理嵌套实体(例如,获取文档位置的方法getPositions(String, ApiParam...)
)。
文档导出
使用模板进行文档导出。要获取特定文档的可用的模板列表,需要在相应的客户端调用方法链metadata()->embeddedtemplate()
。例如,获取出库单的导出模板列表
$templates = $api->entity()->demand()->metadata()->embeddedtemplate();
要使用选定的模板创建打印表单,使用文档客户端的export()
方法。最简单的调用方式如下
$exportFile = new File('demandExport.pdf'); $api->entity()->demand()->export('{demand_id}', $templates->getRows()->get(0), $exportFile);
调用方法后,将创建文件demandExport.pdf
,包含具有id = {demand_id}
的出库单的导出,按照第一个可用的模板。
深入了解
有关Remap API 1.2中可用的方法和实体的列表,以及使用API的限制,请参阅以下链接中的文档:https://dev.moysklad.ru/doc/api/remap/1.2/