Se não for direcionado automaticamente, clique aqui.

O Moip Assinaturas utiliza as mesmas chaves de autenticação do Moip, no padrão HTTP Basic Authentication
Veja mais detalhes sobre a autenticação

"Authorization": "Basic " + BASE64(MOIP_API_TOKEN:MOIP_API_KEY)

Para acessar as chaves (TOKEN e KEY), siga os passos abaixo:

  1. Acesse o www.moip.com.br e efetue o login;
  2. Clique em Ferramentas na barra de opções;
  3. Clique em API Moip e depois, em Chave de Acesso
  4. Seu TOKEN será exibido na página, e no link abaixo dele, estará o KEY.

Os serviços de consultar planos, clientes, assinaturas e cobranças são paginados de acordo com o padrão abaixo. Os registros são atualmente ordenados pela data de criação em ordem decrescente.

Exemplo
GET

Exemplo de consulta com limite (limit) de 10 resultados começando pelo décimo resultado (offset). Neste exemplo, o retorno será dos registros 11 a 20.

Parâmetros
parâmetro tipo descrição
limit inteiro Quantidade de registros por busca (página). O valor default é 100.
offset inteiro Registro a partir do qual a busca vai retornar.O valor default é 0.

O Moip Assinaturas utiliza o padrão HTTP Status nas respostas das requisições. Concentramos as respostas possíveis em poucos códigos:

HTTP Status Descrição
2xx Sucesso
200 Requisição feita com êxito.
201 Recurso criado com êxito.
4xx Erro
400 Houve um erro ou uma falha na requisição (ela não foi concluída).
401 Não autorizado. O token de autenticação não é válido ou ele não está habilitado para o Moip Assinaturas.
404 Recurso não encontrado.

Ao receber um HTTP Status 400, você também receberá no body um código e uma mensagem referente ao motivo do erro ou do alerta na requisição.

Você vai receber um erro se o formato da requisição estiver com algum problema de sintaxe ou se houver algum erro na validação de um atributo (exemplo: caracteres inválidos para aquele atributo).

Os alertas auxiliam o desenvolvedor na integração uma vez que informam como melhorar a integração, aumentar a conversão de pagamentos e prevení-lo de futuros erros.

Exemplo

{
    "message": "Erro na requisição",
    "errors": [
        {
            "code": "MA1",
            "description": "Código já utilizado. Escolha outro código."
        }
    ]
}

Tabela de erros e alertas

Você pode encontrar a tabela completa de erros e alertas na página Erros e Alertas.