Padrão de Arquitetura REST

API

É o acrônimo para Application Programming Interface, sendo utilizada para que entidades externas a uma aplicação possam usufruir de recursos e funcionalidades do sistema.

Nossa API segue as práticas do padrão de arquitetura REST, um acrônimo para Representational State Transfer. Esta é uma arquitetura de interfaces que permite realizar a troca de dados entre sistemas utilizando um formato padronizado.

Através da API REST, podemos utilizar verbos específicos para realizar uma série de operações em determinados objetos, como a criação, a solicitação, a edição ou a remoção de um recurso, por exemplo: api/v2/users (por padrão os recursos estarão sempre no plural).

Endpoints
Representam as URLs dos recursos da API. São como os endereços de cada recurso.

Headers (cabeçalhos)
São uma parte essencial de requisições e respostas HTTP, utilizadas para transportar informações sobre o cliente, o conteúdo da requisição, o conteúdo esperado na resposta, entre outras informações relevantes conforme cada situação.

Payload
Consiste nos dados que são transmitidos em uma requisição HTTP. Não são todos os verbos e/ou recursos que permitem o envio de um payload, sendo que aqueles que permitem podem variar o tipo ou formato de dados.

JSON
Acrônimo para JavaScript Object Notation, sendo utilizado como uma estrutura padrão para a transferência de dados entre cliente e servidor.

Webhooks
Mecanismos que transmitem notificações de eventos automaticamente para endpoints previamente registrados no servidor, sem necessidade de realizar uma consulta ativa. Ao contrário das APIs tradicionais que respondem à requisições, os webhooks enviam informações quando certos eventos ocorrem.