Introdução às APIs

Bem-vindo ao grande mundo das APIs!

Neste artigo, você aprenderá:* O que é uma API* O que é uma API RESTful* Como trabalhar com as APIs da Tulip

O que é uma API?

Uma API (Interface de Programação de Aplicativos) é um conjunto de protocolos que permite que diferentes componentes de software se comuniquem e transfiram dados.

Os desenvolvedores usam APIs para preencher as lacunas entre pedaços pequenos e discretos de código, a fim de criar aplicativos poderosos, resilientes, seguros e capazes de atender às necessidades dos usuários.

Há quatro partes principais em uma API:1. Cliente de API - como você pode iniciar uma solicitação de API.2. Solicitação de API - uma solicitação para que uma API execute uma ação ou forneça informações de volta para você.3. Servidor de API - confirma de onde a solicitação está vindo, se a solicitação está bem formada e recupera ou manipula os dados solicitados.4. Resposta de API - a resposta de volta para você (o cliente).

Solicitação de API

Uma solicitação de API consiste em cinco partes principais:

• Ponto de extremidade: Trata-se de um URL dedicado que fornece acesso a um recurso específico. Por exemplo, o endpoint /tables permite que você obtenha todas as tabelas da Tulip ou crie uma nova tabela da Tulip.
• Method (Método): Esse é o tipo de operação que você gostaria que a API realizasse. Como a Tulip utiliza APIs REST, elas são limitadas a GET, PUT, POST e DELETE.
• Parâmetros: Variáveis que são passadas para um endpoint de API para fornecer instruções específicas para a API processar. Expandindo os exemplos anteriores do ponto de extremidade /tables, você pode especificar um ID de tabela específico por meio de /tables/{tableId}. Além disso, temos consultas que podem modificar ainda mais os parâmetros.
• Cabeçalhos de solicitação: Pares de valores-chave que fornecem detalhes sobre a solicitação, como o tipo de conteúdo ou as credenciais de autenticação.
• Corpo da solicitação: Parte principal da solicitação que detalha quais dados são necessários para criar, atualizar ou excluir um recurso. Por exemplo, na URL de estações, você pode criar uma nova estação e detalhar de que grupo de estações ela deve fazer parte e quais aplicativos ela pode conter.

Resposta da API

Quando você monta e envia uma solicitação REST com êxito, os servidores respondem com o seguinte:

• Um código de status: Códigos de três dígitos que indicam o resultado de uma solicitação de API.
• Cabeçalhos de resposta: Fornecem informações adicionais sobre a resposta do servidor.
• Corpo da resposta: o corpo da resposta inclui os dados ou o conteúdo real solicitado pelo cliente ou uma mensagem de erro, caso algo tenha dado errado.

Os códigos de status HTTP comuns incluem:

200 OK: Indica que a solicitação foi bem-sucedida e que o corpo da resposta contém o recurso solicitado**.404 Not Found (404 não encontrado): Indica que o servidor não consegue encontrar o recurso solicitado, geralmente devido a um URL digitado incorretamente ou a um recurso que foi movido ou excluído.400 Bad Request**: Significa que o servidor não pode processar a solicitação devido a um erro do cliente, como sintaxe inválida ou falta de parâmetros obrigatórios na solicitação**.500 Internal Server Error**: Indica que o servidor encontrou uma condição inesperada que o impediu de atender à solicitação, geralmente um problema do lado do servidor fora do controle do cliente**.302 Found (Moved Temporarily): Indica que o recurso solicitado foi temporariamente movido para um URL diferente. O cliente deve emitir outra solicitação para o novo URL fornecido no cabeçalho da resposta.401 Não autorizado**: Significa que a solicitação requer autenticação do usuário, mas o cliente não forneceu credenciais válidas ou ainda não se autenticou.

Leia mais sobre os códigos de erro HTTP aqui.

O que é uma API RESTful?

A Tulip utiliza APIs RESTful. Outros tipos de APIs incluem SOAP, GraphQL, Webbhooks ou gRPC.

Uma API REST, também conhecida como RESTful API, é uma interface simples e uniforme usada para disponibilizar dados, conteúdo, algoritmos, mídia e outros recursos digitais por meio de URLs da web. As APIs REST são as APIs mais comuns usadas na Web atualmente.

As APIs REST usam quatro métodos principais:1. GET: Esse método permite que o servidor encontre os dados solicitados e os envie de volta para você.2. PUT: se você executar a solicitação PUT, o servidor atualizará uma entrada no banco de dados.3. POST: Esse método permite que o servidor crie uma nova entrada no banco de dados.4. DELETE: Esse método permite que o servidor exclua uma entrada no banco de dados.

Como trabalhar com a API da Tulip

Leia os artigos a seguir para começar a usar e testar APIs com a Tulip:

• O que são conectores?
• Como criar e configurar uma função de conector HTTP
• Configuração de uma API da Tulip

Encontrou o que estava procurando?

Você também pode acessar community.tulip.co para postar sua pergunta ou ver se outras pessoas tiveram uma pergunta semelhante!