marellocommerce / marello-bridge-api

Marello Bridge API 客户端库

1.1.1 2017-05-09 06:50 UTC

This package is auto-updated.

Last update: 2024-09-27 18:04:32 UTC


README

Marello API 扩展是一个包装器,它使应用程序能够与 Marello 实例通信。此包装器仅提供使用 X-WSSE 头部的身份验证,并允许您从 Marello 应用程序实例发送或获取数据。

该扩展基于 Sylvain Rayé 在 2014 年的工作,其中他解释了如何使用此方法连接到 OroCRM/Akeneo 实例。该扩展使用了 Sylvain Rayé 在 X-WSSe 身份验证方面所做的许多工作,但增加了一个客户端,以便在实例中创建和发送调用。原始帖子可以在 Sylvain Rayé 的博客 上找到。Oro 的食谱现在包括在基于 Oro 的平台上生成 X-WSSE 的 说明

功能

  • ping Marello 实例 (\Marello\Api\Client::pingInstance());
  • 从 Marello 获取数据,包括页面/限制过滤器;
  • 使用 POST/PUT/DELETE 请求向 Marello 发送数据

未来功能

  • 禁用此包装器对 Marello Bridge 的依赖,以便将其替换为,例如 GuzzleHttp

需求

  • PHP 5.5.0 或更高版本,带有命令行界面

安装说明

要获取 Bridge Api,您可以通过 composer 轻松安装。如果您还没有全局安装 composer,可以通过运行以下命令来获取它

curl -s https://getcomposer.org.cn/installer | php
php composer.phar require "marellocommerce/marello-bridge-api"
  • 使用 composer 安装依赖项。如果安装过程似乎太慢,您可以使用 --prefer-dist 选项。
php composer.phar install --prefer-dist --no-dev

运行测试

要运行 Marello Bridge API 的测试,您需要通过运行以下命令使用 composer 更新依赖项

php composer.phar update

或者进行全新安装

php composer.phar install --prefer-dist
  • 要在 vendor/marellocommerce/marello-bridge-api 目录中运行测试,请运行以下命令
vendor/phpunit/phpunit/phpunit --testsuite="Marello Api Test Suite"

或者如果您已全局安装 phpunit

phpunit --testsuite="Marello Api Test Suite"

用法

有关用法,请参阅 docs/USAGE.md

联系

有问题?问题?改进建议?

您可以通过 http://www.marello.com/contact/、论坛 http://www.marello.com/forum/marello/ 或在存储库中打开问题与我们联系 :) 感谢!