Nossa API é desenvolvida usando a arquitetura REST, com alguns poucos endpoints que misturam este conceito com ações a serem realizadas em nossas entidades.
Fique atento aos seguintes pontos quando estiver integrando conosco:
Ambiente
Nossa API é disponibilizada em ambiente de staging e produção, sendo que o ambiente de staging deve ser utilizado para o seu processo de desenvolvimento.
Abaixo, seguem as URLs de cada ambiente:
| Ambiente | URL |
|---|---|
Staging | https://api.stg.paggi.com |
Produção | https://api.paggi.com |
Status HTTP
Como em toda arquitetura REST, os status HTTP que retornamos nas requisições são importantes, e devem ser utilizados para entender qual foi o resultado de um pedido que você fez à nossa API.
Abaixo, listamos todos os status que são utilizados em nossa API e suas respectivas interpretações:
| STATUS HTTP | DESCRIÇÃO |
|---|---|
| 200 | Os dados que você pediu estão no corpo da resposta |
| 201 | Seu pedido para criar uma nova entidade deu certo, mais detalhes no corpo da resposta |
| 400 | Algum parâmetro ou cabeçalho HTTP requerido está ausente |
| 401 | O token que você enviou é inválido ou expirado |
| 402 | Uma ou mais cobranças foram negadas |
| 422 | Foi encontrado algum erro validando algum parâmetro do corpo da requisição |
| 500 | Ocorreu algum erro na aplicação da API da Paggi |
| 501 | O método HTTP que você usou não é implementado para o recurso solicitado |
| 502 | Ocorreu um erro na infraestrutura da Paggi |
| 503 | Ocorreu um erro na infraestrutura da Paggi |
Representação de dados
Todos os dados trafegados de e para nossa API devem ser codificados como JSON.
Isto significa que todas as respostas devolvidos por nossa API serão representadas com um JSON.
Também significa que tudo que você nos enviar no corpo das suas requisições deverá está codificado em JSON, e estas requisições deverão conter o cabeçalho Content-Type com o valor application/json.