Conecte-se a APIs sem código: 8 etapas

2024 Autor: John Day | [email protected]. Última modificação: 2024-01-30 11:35

Este guia foi desenvolvido para pessoas que desejam realizar algo que requer o uso de uma API, mas não têm certeza de como começar. Você já sabe por que trabalhar com uma API é útil e este guia mostrará como fazer isso.

Se isso soa como você, você está com sorte! Estamos aqui para explicar como trabalhar com APIs, como ler documentos de API e como realmente usar os dados que vêm de uma API.

Trouxemos um amigo para tornar a viagem muito mais fácil.

Conheça Slash

Slash é o cão adorável e adorável de Michelle (foto acima). Michelle é uma engenheira de software que cria APIs. Michelle realmente gosta de seu trabalho e se inspirou em seu trabalho de criação de APIs no treinamento de Slash.

Como você deve saber, uma API é uma coleção de comandos que um usuário pode dar a um serviço da web junto com um conjunto de respostas que correspondem à solicitação. Michelle treinou Slash para fazer exatamente o mesmo. Slash é um bom menino, conhece uma variedade de comandos e sempre responde corretamente, desde que você dê a ele um pedido que ele aprendeu. Quando ele fica extremamente animado, seu rabo enlouquece - isso não é algo que Michelle lhe ensinou sobre APIs, é apenas porque ele é um cachorrinho adorável e realmente gosta de seu treinamento!

Etapa 1: Decida qual API você precisa

Quais informações você está procurando ou deseja alterar?

Você está tentando pegar todas as postagens do Instagram de @ dougthepug? Talvez você queira tweetar automaticamente para qualquer pessoa que segue o twitter do seu cachorro (porque, embora os cães não possam falar, eles têm muito a dizer, sabemos que Slash tem).

Se você já conhece o site ou API ao qual está tentando se conectar, vá diretamente para a Etapa 2. Se você está tentando encontrar dados, mas não sabe por onde começar, o Google é seu amigo. Pesquise por "[coisas em que você está interessado] API" e veja o que surge. Você pode se surpreender com a quantidade de informações disponíveis.

Se você quiser um exemplo de API simples, pode usar o que Michelle fez durante o treinamento de Slash. Ele tem alguns de seus comandos favoritos, como recuperar bolas e cavar buracos. Nós o usaremos no restante de nossos exemplos.

Etapa 2: Encontre os documentos da API

APIs fornecidas por empresas conhecidas devem ter documentação completa sobre como usá-los.

Para localizá-los, pesquise no google "[Insert Company] API documentation" ou "[Insert Company] developer".

Os resultados devem levá-lo ao portal do desenvolvedor. Procure um link que diz "Docs", "Documentação", "Referência" ou "Referência Técnica".

Nos documentos, pode ser necessário procurar a API específica desejada, pois às vezes pode haver muitas opções. O Facebook, por exemplo, tem APIs separadas para marketing, anúncios, páginas e muito mais.

Se a API à qual você deseja se conectar não é bem conhecida (como a do Slash), pode ser necessário solicitar a documentação ao desenvolvedor. Eles podem ter um PDF contendo as informações de que você precisa ou documentação online que não está listada em seu site.

Se você perdeu o link na etapa anterior, os documentos da API do Slash podem ser encontrados aqui.

Etapa 3: Encontre o ponto final

Os documentos da API podem parecer assustadores, mas uma vez que você sabe o que procurar, eles geralmente são bem estruturados e padronizados.

A primeira coisa a procurar é o (s) ponto (s) de extremidade apropriado (s). Deve haver um ponto de extremidade correspondente a cada tipo de dados que você deseja. Um endpoint pode ser assim:

slashtheapidog.com/api/bones/{id}

ou apenas

/ossos

A documentação deve ter uma lista de terminais. Eles podem estar no nível superior nos documentos ou em uma seção chamada "referência", "pontos de extremidade" ou "métodos". Para encontrar o endpoint correto, procure o nome que corresponde aos dados que você está procurando. Por exemplo, se você quiser uma lista de todos os buracos que Slash cavou, / buracos é provavelmente o certo. Em qualquer caso, cada terminal deve ter uma descrição para ajudar a explicar o que ele faz.

De acordo com seus documentos, estes são os pontos de extremidade na API do Slash relacionados a furos:

OBTER

OBTER

POST

PUT

POST

Etapa 4: Determine o seu tipo de solicitação

Agora que encontrou o endpoint certo, você precisa determinar o tipo de solicitação para enviá-lo.

Existem 4 tipos diferentes de solicitações:

PEGUE

Uma solicitação GET é como você pede à API para responder com algo que ela possui, na maioria das vezes dados. Você pode solicitar informações específicas sobre um item ou grupo de itens com base no terminal e nos parâmetros. Isso é o equivalente a pedir a Slash para trazer para você um de seus ossos ou todos os seus ossos.

PUBLICAR

Uma solicitação POST é como você diz à API para criar algo novo. Isso é semelhante a pedir ao Slash para cavar (criar) um novo buraco para você.

POR

Uma solicitação PUT é como você informa à API para atualizar algo que foi criado anteriormente. Isso é semelhante a pedir a Slash para cavar mais fundo (atualizar) no buraco que ele cavou.

EXCLUIR

Uma solicitação DELETE é como você informa à API para excluir algo que foi criado anteriormente. Isso é semelhante a pedir a Slash para cobrir (deletar) um buraco que ele cavou anteriormente.

Pense nesses quatro tipos. Você está obtendo informações, criando uma nova entrada, alterando uma entrada existente ou excluindo uma? Essa resposta informa exatamente o tipo de solicitação de que você precisa.

Etapa 5: compreender os parâmetros

Muitos pedidos requerem parâmetros adicionais. Os parâmetros são os detalhes de sua solicitação. Por exemplo, se você deseja que o Slash traga para você todas as bolas que são vermelhas, você precisa especificar a cor. Se você quiser que ele crie um novo buraco, você precisa dizer a ele onde colocá-lo e a que profundidade cavar.

A documentação da API que você está referenciando deve ter uma seção chamada "Parâmetros" ou "Opções" para cada terminal e tipo de solicitação. Preste atenção a quais parâmetros são obrigatórios, pois alguns são opcionais. Se um parâmetro for marcado como opcional, os documentos podem fornecer um exemplo que também é o padrão.

Os parâmetros da API do Slash podem ser parecidos com isto para recuperar bolas:

OBTER

Etapa 6: formate sua solicitação

Temos todas as informações de que precisamos, agora só precisamos fazer a solicitação!

Aqui estão duas maneiras diferentes de se conectar a uma API que não requer código. Vamos nos conectar à API do Slash para obter sua lista de bolas fazendo uma solicitação GET para

Parábola - se você deseja se conectar e trabalhar com dados sem código

Parabola é um aplicativo da web que permite que você se conecte facilmente a APIs e trabalhe com os dados por meio de uma ferramenta visual de arrastar e soltar.