Padrão de Arquitetura REST

API

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

Por exemplo, no Melhor Envio, você vai usar nossas APIs para integrar algumas de nossas funcionalidades em seu sistema. Dessa forma, os usuários de sua plataforma vão poder usufruir de forma transparente dessas funcionalidades sem a necessidade de trocar de plataforma.

Nossa API segue as práticas do padrão de arquitetura REST, um acrônimo para Representational State Transfer. Este é um padrão de 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 devem ser sempre no plural).

Alguns dos conceitos relacionados você pode ver abaixo.

Endpoint
Endpoints representam as URLs dos recursos da API. São como os endereços de cada recurso.
Headers
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
Payload consiste nos metadados que são transmitidos em uma requisição HTTP. Basicamente são os dados que serão enviados no momento da requisição. 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 que são permitidos serem enviados.
JSON
JSON é o acrônimo para JavaScript Object Notation, sendo utilizado como uma estrutura padrão para a transferência de dados entre cliente e servidor.
Webhooks
Webhooks são endpoints registrados no servidor para que um cliente possa ser comunicado do acontecimento de algum evento. Funcionam como assinaturas ou inscrições para receber determinados eventos relacionados a determinados recursos. Diferentemente de APIs, onde o provedor retorna dados quando requisitado, os webhooks comunicam os dados com base em eventos que ocorrem no provedor.