Como funcionam as APIs Rest no Zeev

Esta página contém informações passo a passo para você entender mais sobre o funcionamento de APIs no Zeev e integrações de sistemas externos

Visão geral

Este conteúdo foi criado para que você compreenda e domine o uso de APIs de forma prática e aplicada ao seu dia a dia, mesmo que você não tenha formação técnica.

Ao longo dos materiais, você vai entender como funcionam as integrações, como consultar e enviar dados com segurança, interpretar respostas em JSON, aplicar filtros OData e explorar possibilidades no Zeev. O objetivo é que ao final você se sinta capaz de construir suas próprias integrações, otimizando processos e usando as APIs do Zeev.

Antes de mais nada, é preciso entender como usar uma API no Zeev. Por isso é preciso compreender o conceito de APIs no contexto da nossa plataforma, visualizando o que são e por que você pode querer usá-las.

Conceitos básicos

Além de entender o que é uma API, é preciso compreender alguns conceitos básicos. APIs (Application Programming Interfaces) permitem que diferentes sistemas “conversem” entre si, ou seja, você pode fazer o Zeev enviar e receber dados com outras ferramentas de forma automatizada. O exemplo usado aqui no vídeo é uma comparação com um aplicativo de delivery.

Como funciona uma API Rest

Existem diversos tipos de APIs, como REST, SOAP e GraphQL. Aqui no Zeev utilizamos as APIs do tipo Rest.

As APIs do tipo Rest usam algumas partes, conhecidas como parâmetros. São elas:

PARTE	EXEMPLO	FUNÇÃO
URL ou Endpoint	https://api.exemplo.com/users	Endereço da informação
Métodos HTTP	GET, POST, PUT, PATCH, DELETE	Tipo de ação
Headers	Authorization, Content-Type	Instruções iniciais de codificação
Body	JSON de entrada	É o corpo da requisição

Outro termo que você precisa se familiarizar ao lidar com as APIs Rest são os Métodos.

MÉTODO	Ação principal	EXEMPLO PRÁTICO
GET	Ler dados	Buscar um cliente
POST	Criar ou executar algo	Criar novo cliente ou uma busca mais complexa
PUT	Substituir recurso	Atualizar cliente por completo
PATCH	Atualizar parcialmente	Alterar apenas o e-mail do cliente
DELETE	Remover recurso	Deletar cliente

Ainda temos conteúdos sobre códigos de retorno, a forma (em JSON) com que os dados são retornados e o passo a passo para consumir uma API Rest.