README

介绍

MoIP Assinaturas (定期付款) 是 MoIP 的一个产品。

本客户端库旨在简化将 MoIP 订阅 API 集成到 PHP 项目中的过程。

关于项目

本项目使用 ActiveResource 框架 Restinga。

官方文档

该包的文档是官方文档的副本，可在 http://dev.moip.com.br/assinaturas-api/ 找到

项目状态

包的当前覆盖率状态

文档内容

• 第一步
• 安装
• 配置
• 一般说明
• 错误管理
• 示例

第一步

安装

要安装 moip-subscriptions 库，您应使用 composer 将其作为依赖项添加到您的项目中。

composer require artesaos/moip-subscriptions

配置

安装库后，您需要配置您的 token 和 API 密钥，并指定是否在生产环境中进行调用

use Artesaos\MoIPSubscriptions\MoIPSubscriptions;

$token = '0011001100110011001100110011';
$key = '10101010101010101010010101010101010';
$production = false;

// A chamada setCredentials recebe 3 parametros
// O Token da API, a Chave da API e a indicação de produção ou não (true/false)
MoIPSubscriptions::setCredentials($token, $key, $production);

一般说明

API 的每个功能/类基本上以相同的方式工作，但所有可用方法都（或将要）在此手册中记录。尽管如此，从 Restinga 库继承的一些方法，如 $resource->destroy() 即使可用，对 API 也没有影响。

错误管理

为了管理 API 可能显示的错误，您可以使用 ->hasErrors() 方法来发现请求中是否发生错误，以及 ->getErrors() 方法，它本身有如 ->first() 和 ->all() 这样的方法。

以下错误管理的示例基于 Plan 类，但请不要担心，该类尚未被覆盖，您只需现在了解错误流程即可。

让我们在以下示例中尝试更改具有负值的计划，我们知道 API 不允许这样做。我们这样做只是为了演示错误处理。

use Artesaos\MoIPSubscriptions\Resources\Plan;

// Busca um Plano Já cadastrado com código 'plan123'
$plan = Plan::find('plan123');

// Configuramos um valor negativo no plano
$plan->amount = -2200;

// Se o plano não pode ser salvo
if(!$plan->save()) {
    // e se Existe alguma mensagem de erro disponível
    if ($plan->hasErrors()) {
        // Método 1: obter um array com as mensagens de erro
        $errors = $plan->getErrors()->all();
        // Método 2: obter apenas o primeiro erro (caso hajam mais de 1 erro)
        $error = $plan->getErrors()->first();
    }

}

示例

@todo