README

一个myERP API的PHP客户端库。

使用Composer进行安装

假设composer.phar位于您的项目根目录中，请运行以下命令

php composer.phar require myerp/myerp-php-api-client:~1.0.2

入门

此包装器使用Guzzle与REST网络服务进行通信。

• 1 - 从API设置中获取您的API_KEY和API_EMAIL。更多信息这里。

• 2 - 通过以下方式初始化客户端

use MyERP\MyERP;
$myERP = new MyERP('API_EMAIL', 'API_KEY');

• 3 - 现在您可以为您的域做出授权的API请求了！

// Get all the customers and leads
$customers = $myERP->customers()->findAll();
var_dump($customers);

// Get a specific customer/lead
$customer = $myERP->customers()->find(261367);
echo $customer['full_name'] . ' [id=#' . $customer['id'] . ']' . "\n";

// create a customer
$jane = [
    "type" => 2, //individual
    "status" => 1, //customer
    "first_name" => "Jane",
    "last_name" => "Doe",
    "email" => "jane.doe@mail.com"
];
$jane = $myERP->customers()->save($jane);
echo $jane['full_name'] . ' created [id=#' . $jane['id'] . ', email=' . $jane['email'] . ']' . "\n";

// update some fields
$jane['email'] = 'newemail@mail.com';
$jane = $myERP->customers()->save($jane);
echo $jane['full_name'] . ' updated [id=#' . $jane['id'] . ', email=' . $jane['email'] . ']' . "\n";

// delete a customer
$byeJane = $myERP->customers()->delete(261368);
echo $byeJane['full_name'] . ' deleted [id=#' . $byeJane['id'] . ', email=' . $byeJane['email'] . ']' . "\n";

// catching errors
try {
  $response = $myERP->customers()->find(2613670);
  //....
} catch(APIException $e) {
  echo $e->getCode() . ' ' . $e->getMessage();
}

贡献

感谢您考虑为该项目做出贡献。

寻找可以做的事情

询问，或选择一个问题并评论，表明您希望工作于此。理想情况下，等待我们分配给您，以最大限度地减少工作重复。

报告问题

• 在提出新问题之前，先搜索现有的问题。

• 尽可能提供详细信息。

拉取请求

• 在问题跟踪器中清楚地说明您正在做什么，以便其他人不会重复工作。

• 使用功能分支，而不是master。

• 在提出PR之前，将功能分支rebase到origin/master。

• 与master中的更改保持同步，以便您的PR易于合并。

• 在PR消息中描述性：它是什么，为什么需要它等。

• 确保测试通过

• 尽可能压缩相关的提交。

编码风格

• 尽量与现有的缩进风格相匹配。

• 不要滥用预处理器。

• 不要将特定于平台的内容混合到主代码中。

许可证

myERP API包装器在MIT许可证下发布。