Download the PHP package artesaos/moip-subscriptions without Composer
On this page you can find all versions of the php package artesaos/moip-subscriptions. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download artesaos/moip-subscriptions
More information about artesaos/moip-subscriptions
Files in artesaos/moip-subscriptions
Package moip-subscriptions
Short Description MoIP Subscriptions PHP Client
License MIT
Informations about the package moip-subscriptions
MoIP Subscriptions
Introdução
MoIP Assinaturas (Pagamentos Recorrentes) é um produto da MoIP.
A Presente biblioteca cliente visa facilitar a integração / implementação da API de Assinaturas em projetos PHP.
Sobre o Projeto
O Projeto utiliza o framework ActiveResource Restinga.
Documentação Oficial
A documentação do pacote é uma cópia da documentação oficial, que pode ser encontra em http://dev.moip.com.br/assinaturas-api/
Status do Projeto
Status atual da Cobertura do Pacote
Endpoint | Implementação | Exemplos |
---|---|---|
coupons (Cupons) |
100% | 0% |
plans (Planos) |
100% | 0% |
customers (Clientes) |
100% | 0% |
subscriptions (Assinaturas) |
100% | 0% |
- invoices (Faturas) |
100% | 0% |
--- payments (Pagamentos) |
100% | 0% |
--- retries (Re-rentativas) |
100% | 0% |
users/preferences (Preferências) |
0% | 0% |
Conteúdo da Documentação
- Primeiros Passos
- Instalação
- Configuração
- Intruções Gerais
- Gerenciamento de Erros
- Exemplos
Primeiros Passos
Instalação
Para instalar a biblioteca moip-subscriptions, você deve utilizar o composer para incluí-la como dependência em seu projeto.
Configuração
Após instalar a biblioteca, você precisará configurar seu token e chave da API, bem como indicar se as chamadas serão feitas no ambiente de produção ou não:
Instruções Gerais:
Cada recurso / classe da API funciona praticamente da mesma forma, porem todos os métodos disponíveis estão (ou serão) documentados nesse manual.
Alguns métodos herdados da biblioteca Restinga como $resource->destroy()
mesmo que disponíveis, não fazem efeito contra a API.
Gerenciamento de Erros
Para gerenciar os erros que a API poderá exibir, você pode utilizar o método ->hasErrors()
para descobrir se houve algum erro na requisição, e o método ->getErrors()
que por sua vêz tem métodos como ->first()
e ->all()
.
O exemplo a seguir de gerenciamento de erros é baseado na classe Plan
, mas não se preocupe que essa classe ainda não está coberta, você só precisa entender o fluxo dos erros agora.
Vamos no exemplo tentar alterar um plano com valor negativo, o que já sabemos que a API não permite. Faremos isso apenas para demonstrar o tratamento de errors.
Exemplos
@todo