Primeiros Passos

Respostas da API

Antes de prosseguir, certifique-se que leu o tópico Requisições da API.

Todas as requisições às API's irão retornar dados no formato JSON.

Nas API's da Asteroide Tecnologia e Pagamento as respostas podem conter os recursos solicitados (parciais ou completos), mensagens de erros ou códigos de status HTTP.

É utilizado uma estrutura, conforme a Tabela 01, para auxiliar você na hora de integrar o retorno à aplicação da sua aplicação.

Tabela 01 - Componentes da Resposta JSON.
http_status Inteiro O código que o servidor retornou, onde:
200 - indica um ou mais recursos retornados. Veja Ex. 01;
201 - indica um recurso criado. Veja Ex. 02;
400 - indica erro ao solicitar ou criar um recurso. Veja Ex. 03;
401 - indica credenciais de autenticação inválidas. Veja Ex. 04;
404 - indica um ou mais recursos não encontrados. Veja Ex. 05.
body[] Array Um ou mais recursos solicitados ou criados. Para alguns endpoints podem ser fornecidos dados parciais.
body.errors[] Array Uma ou mais mensagem de erro indicando uma ou mais inconsistências nos formatos ou tipos de dados no JSON enviado.

Exemplos

Veja alguns exemplos de retorno.

{
    "http_status": 200,
    "body": {
        "seu_id": "ABC123",
        "codigo_pagamento": "10219010808251000090",
        "data_estorno": "2019-01-08 10:20:45"
    }
}"
{
    "http_status": 201,
    "body": {
        "data_vencimento": "2019-01-18",
        "url_boleto": "https://api.asteroidetecnologia.com.br/b/venda.5c3cbee68cd671.00157131",
        "numero_boleto": 14,
        "linha_digitavel": "34191.09008 00001.490051 72219.540001 3 77790000010000",
        "tipo": "boleto",
        "guid": "venda.5c3cbee68cd671.00157131"
    }
}
{
    "http_status": 400,
    "body": {
        "errors": [
            "Undefined index: guid"
        ]
    }
}
{
    "http_status": 401,
    "body": {
        "errors": [
            "Unauthorized request. Problema na autenticação"
        ]
    }
}
{
    "http_status": 404,
    "body": {
        "errors": [
            "Não encontrada."
        ]
    }
}