Introdução

Esta documentação fornece as informações necessárias para integrar e utilizar a API Report Extrato - SDX. Esta API permite a geração e manipulação de relatórios de extrato através de chamadas HTTP. A integração envolve a realização de chamadas para diferentes endpoints que gerenciam dados relacionados a relatórios de extrato.

Endpoints Principais

1. Geração de Relatório de Extrato

Endpoint: GET <https://sandbox-bff.barte.com/service/core/redeems/statement>

Descrição: Gera um relatório de extrato baseado nos parâmetros fornecidos.

Headers:

• Content-Type: application/json
• Authorization: Bearer {token}

Parâmetros de URL:

• executionDateInitial: Data inicial para a geração do relatório (formato YYYY-MM-DD).
• executionDateFinal: Data final para a geração do relatório (formato YYYY-MM-DD).

Exemplo de Requisição:

http
GET /service/core/redeems/statement?executionDateInitial=2023-01-01&executionDateFinal=2023-01-31&page=0&size=100 HTTP/1.1
Host: sandbox-bff.barte.com
Authorization: Bearer {token}
Content-Type: application/json

Response:

• 200 OK: Relatório gerado com sucesso. Retorna o conteúdo do relatório.

  json
    "content": [
      {
        "amount": 1000.00,
        "amountTax": 100.00,
        "uuid_charge": "123e4567-e89b-12d3-a456-426614174000",
        "statementType": "SALE",
        "execution_date": "2023-01-15"
      }
    ],
    "page": 0,
    "size": 100,
    "totalElements": 1,
    "totalPages": 1
  }
  
  

• 400 Bad Request: Parâmetros inválidos ou faltantes.

  json
  {
    "errors": [
      {
        "code": "BAR-0504",
        "title": "Período Inválido",
        "description": "Verifique se você inseriu datas válidas."
      }
    ]
  }
  
  

Possíveis Erros e Tratamento

Os possíveis erros que podem ser retornados pela API incluem, mas não se limitam a:

• 400 Bad Request: Parâmetros inválidos ou malformados.
  • Códigos de erro:

    • BAR-0500: Método inválido.

      json
      {
        "errors": [
          {
            "code": "BAR-0500",
            "title": "Método inválido",
            "description": "A requisição deverá ser chamada com GET."
          }
        ]
      }
      
      

    • BAR-0501: Chave de API inválida.

      json
      {
        "errors": [
          {
            "code": "BAR-0501",
            "title": "Chave de API Inválida",
            "description": "A chave de api está incorreta ou inativada."
          }
        ]
      }
      
      

    • BAR-0503: Serviço inválido.

      json
      {
        "errors": [
          {
            "code": "BAR-0503",
            "title": "Serviço inválido",
            "description": "Entre em contato com o suporte."
          }
        ]
      }
      
      

    • BAR-0504: Período inválido.

      json
      {
        "errors": [
          {
            "code": "BAR-0504",
            "title": "Período Inválido",
            "description": "Verifique se você inseriu datas válidas."
          }
        ]
      }