Endpoints
Os endpoints da nossa API utilizam o padrão de arquitetura REST (Representational State Transfer - Transferência de Estado Representacional) que é uma abordagem arquitetural simples, escalável e interoperável. Esse padrão utiliza conceitos como recursos, operações CRUD (mapeadas com os métodos HTTP: POST, GET, PUT/PATCH e DELETE) e URIs para definir uma interface padrão e uniforme para a comunicação entre clientes e servidores. Os recursos têm uma ou mais representações, que podem ser em formatos como JSON, XML, HTML, entre outros.
Utilizamos o formato JSON para transferência de dados. Portanto, é necessário utilizar o seguinte cabeçalho nas requisições do tipo POST:
"Content-Type": "application/json"
Nas próximas páginas, você terá acesso a informações detalhadas sobre os recursos disponíveis, exemplos de uso e outros conceitos relevantes para a integração.
Não deixe de conferir a seção “Referência” que fornece uma visão mais técnica da API!