Como usar a API?

8 min de leitura

Eu costumava trabalhar no atendimento ao cliente em uma empresa de tecnologia onde as conexões de API que extraíam dados de usuários de outros programas eram parte integrante do produto. Quando eu explicava aos clientes por que não podíamos acessar um determinado elemento de dados, os desenvolvedores frequentemente recomendavam a resposta: “Não está disponível via API”.

Na época, eu pensava que uma API era como uma porta USB, e ao conectar-se a essa porta, teríamos acesso a tudo em outro programa. Acontece que eu estava errado.

A voir aussi : Como Usar a C Cedilha em Maiúscula no Seu Texto?

Leia também: Zapier vs IFTTT: a melhor ferramenta para automação de tarefas

As APIs são menos como portas USB ou mangueiras de incêndio do que como uma pessoa em um centro de atendimento em um país estrangeiro. Uma API não lhe dará todas as informações ou o código de um programa (como uma mangueira de incêndio), porque o que impediria você de replicar toda a base de código? Em vez disso, uma API fornece dados que seus programadores disponibilizaram para usuários externos. Mesmo assim, você precisa saber e fazer as perguntas certas para fazer qualquer coisa com esses dados.

A découvrir également : Como usar bem uma calça jeans?

O que é uma API?

API significa interface de programação de aplicativos. A parte mais importante desse nome é “interface”, pois uma API basicamente fala com um programa por você. Você sempre precisa conhecer a linguagem para se comunicar com o programa, mas sem API, você não irá muito longe.

Quando os programadores decidem tornar alguns de seus dados acessíveis ao público, eles “expostos os pontos de extremidade”, o que significa que publicam uma parte da linguagem que usaram para criar seu programa. Outros programadores podem então extrair dados do aplicativo criando URLs ou usando clientes HTTP (programas especiais que criam as URLs para você) para solicitar dados a partir desses pontos de extremidade.

Os pontos de extremidade retornam texto destinado a computadores lerem, de modo que isso não fará sentido se você não entender o código de computador usado para escrevê-lo.

TL;DR: Uma API permite que um programa solicite dados de outro.

Por que usar uma API

Os computadores facilitam muitas coisas, especialmente tarefas que envolvem coletar e classificar toneladas de dados. Suponha que você queira saber quantas vezes um terceiro enviou faturas à sua empresa. É possível entrar nos registros de faturas da sua empresa, digitalizar a entrada de dados “de” e imprimir cada fatura individualmente para sua auditoria.

Por outro lado, se todas as faturas foram carregadas em um banco de dados central, você pode escrever um programa simples que acesse esse banco de dados e encontre todas as instâncias do nome do parceiro. Isso levaria muito menos tempo e seria muito mais preciso.

Arquitetura de uma API

As APIs são compostas por três partes:

  • Usuário: a pessoa que faz uma solicitação
  • Cliente: computador que envia a solicitação ao servidor
  • Servidor: o computador que responde à solicitação

Alguém construirá o servidor primeiro, pois ele adquire e detém dados. Uma vez que esse servidor esteja em funcionamento, os programadores publicam documentação, incluindo os pontos de extremidade onde dados específicos podem ser encontrados. Essa documentação informa aos programadores externos a estrutura dos dados no servidor. Um usuário externo pode então consultar (ou pesquisar) os dados no servidor, ou criar um programa que execute pesquisas no banco de dados e transforme essas informações em um formato diferente e utilizável.

É super confuso, então vamos pegar um exemplo real: uma lista de contatos.

Na época analógica, você receberia uma cópia do diretório telefônico das Páginas Brancas, que listava todas as pessoas da sua cidade por nome e endereço, em ordem alfabética. Se você precisasse do endereço de um amigo, poderia procurá-lo pelo sobrenome, encontrar o endereço e, em seguida, procurar a rua deles nos mapas incluídos no verso. Era uma quantidade limitada de informações, e levava muito tempo para acessar. Agora, graças à mágica da tecnologia, todas essas informações podem ser encontradas em um banco de dados.

Vamos construir um banco de dados contendo as páginas brancas para uma cidade fictícia chamada Happyville. As pessoas de HappyVille_WP decidiram que, ao construir seu banco de dados, criariam algumas categorias de informações com dados aninhados abaixo. Esses são nossos pontos de extremidade, e eles incluirão todas as informações que a API publicará para um programa externo.

Aqui estão os pontos de extremidade listados na documentação de HappyVille_WP:

  • /nomes
    • /first_name, /last_name
  • /endereços
    • /street_address, /email_address/
  • /telefones
    • /home_phone, /mobile_phone

Obviamente, essas não são todas as informações que podem ser coletadas sobre uma pessoa. Mesmo que HappyVille_WP coletasse informações mais privadas sobre os residentes de Happyville (como datas de nascimento e números de segurança social), esses dados não estariam disponíveis para programadores externos sem conhecer a linguagem desses pontos de extremidade.

Esses pontos de extremidade indicam a linguagem que você deve usar para solicitar informações a partir do banco de dados. Se você quiser uma lista de todas as pessoas de Happyville com o sobrenome Smith, você pode fazer uma das duas coisas:

  1. Faça uma solicitação de URL em um navegador para essa informação. Isso usa seu navegador de internet como cliente, e você receberá um documento de texto em linguagem de codificação para classificar. Esta URL pode parecer com isto: http://api.happyville_wp.com/names?last_name=smith
  2. Use um programa que solicita as informações e as traduz em uma forma utilizável. Você pode codificar seu próprio programa ou usar um cliente HTTP pronto para uso.

A primeira opção é ideal para fazer consultas simples com apenas algumas respostas (todas as pessoas em Happyville com o sobrenome Xarlax, por exemplo — estou bastante certo de que há apenas seis domicílios com esse nome em Happyville). A segunda opção requer mais fluência em codificação, mas é ideal para programadores que desejam usar o banco de dados de outro programa para aprimorar suas próprias aplicações.

Muitas empresas usam as APIs abertas de grandes empresas como Google e Facebook para acessar dados que poderiam não estar disponíveis de outra forma. Nesse caso, as APIs reduzem significativamente as barreiras de entrada para pequenas empresas que, de outra forma, teriam que compilar seus próprios dados.

Ações que você pode realizar via API

Uau! Ok, então uma API é a maneira como dois computadores falam um com o outro. O servidor possui os dados e define a linguagem, enquanto o cliente usa essa linguagem para solicitar informações ao servidor (para sua informação, os servidores não enviam dados sem que um cliente solicite dados, mas os desenvolvedores encontraram maneiras de contornar isso com webhooks). As APIs podem fazer tudo!

Não tão rápido. A linguagem e a sintaxe das APIs limitam severamente suas capacidades. Existem quatro tipos de ações que uma API pode realizar:

  • GET: solicita dados de um servidor — pode ser um estado ou especificidades (como last_name)
  • POST: envia as alterações do cliente ao servidor; pense nisso como adicionar informações ao servidor, como fazer uma nova entrada
  • PUT: revisa ou adiciona informações existentes
  • DELETE: remove informações existentes

Quando você combina os pontos de extremidade com essas ações, pode pesquisar ou atualizar todas as informações disponíveis via API. Você precisará verificar a documentação da API para saber como codificar essas ações, pois todas são diferentes.

Enquanto falamos sobre linguagem e sintaxe, vamos cobrir as maneiras de como você pode fazer uma solicitação em um servidor:

HTTP: protocolo de transferência de hipertexto. É assim que você chegou ao nosso site em primeiro lugar, digitando uma URL na barra de pesquisa do seu navegador. É uma maneira realmente fácil de acessar os dados, mas não voltará em um formato bonito se você solicitar muitas informações. Vamos mais longe em um segundo.

Formatos de texto: XML, JSON. Essas são as principais linguagens para acessar dados via API. Quando você recebe seus dados, precisará percorrer o código XML ou JSON para entender o que o servidor lhe deu.

Começando a usar uma API

A maioria das utilizações da API que você verá em sua vida profissional diária move informações de um programa para campos de formulário semelhantes em outro programa. Isso é especialmente útil quando você está tentando compartilhar informações que, de outra forma, você teria que inserir repetidamente — por exemplo, compartilhar leads entre sua plataforma de automação de marketing e seu CRM.

As utilizações e exemplos que vamos listar aqui são muito mais básicos e tiram muito menos do que sua API padrão é boa. Mas eles lhe darão uma boa ideia das etapas do processo da API.

  1. A maioria das APIs requer uma chave de API. Uma vez que você encontre uma API com a qual deseja brincar, consulte a documentação para saber as condições de acesso. A maioria das APIs pedirá que você passe por uma verificação de identidade, como fazer login com sua conta do Google. Você receberá uma sequência única de letras e números para usar ao acessar a API, em vez de apenas adicionar seu e-mail e senha toda vez (o que não é muito seguro – para mais informações sobre permissões e verificações, leia isto).
  2. A maneira mais simples de começar a usar uma API é encontrar um cliente HTTP online, como REST-Client, Postman ou Paw. Essas ferramentas prontas para uso (e muitas vezes gratuitas) ajudam você a estruturar suas solicitações de acesso às APIs existentes com a chave de API que você recebeu. Você ainda precisará conhecer uma parte da sintaxe da documentação, mas há muito poucas conhecimentos de codificação necessárias.
  3. A melhor maneira de extrair dados de uma API é criar uma URL a partir da documentação existente da API. Este vídeo do YouTube explica como extrair dados de localização do Google Maps via API e, em seguida, usar essas coordenadas para encontrar fotos próximas no Instagram.

No geral, uma solicitação de API não parece muito diferente de uma URL normal do navegador, mas os dados retornados estarão em uma forma fácil de ler para os computadores. Aqui está o que aconteceu quando eu solicitei informações do banco de dados OpenWeather em meu navegador Web:

Exemplo de URL da documentação — solicita o clima para uma cidade específica:

api.openweathermap.org/data/2.5/weather?q={nome da cidade}

Digite em seu navegador:

api.openweathermap.org/data/2.5/weather?q=Nashville, TN&APIID={numberslettersnumbersletters}

Conclusões e leituras complementares

Uma API é útil para extrair informações específicas de outro programa. Se você sabe ler a documentação e escrever as solicitações, pode recuperar muitos bons dados, mas pode ser esmagador analisar tudo isso. É aí que os desenvolvedores entram em cena. Eles podem criar programas que exibem dados diretamente em um aplicativo ou janela do navegador em um formato facilmente consumível.

Este artigo mal arranha a superfície da tecnologia API. Eu fiz algumas pesquisas na web para aprender mais sobre APIs. Aqui estão os artigos e vídeos que mais me ajudaram:

  • Usando APIs: não é tão difícil quanto parece
  • Como usar APIs com JavaScript
  • API Web para não programadores
  • Cursos Zapier API
  • Conceitos e exemplos da API REST
  • O que são APIs e por que são importantes

Você deseja conectar seus programas, mas não tem tempo para criar um cliente? Existem muitas empresas que conectarão APIs existentes ou construirão conexões personalizadas para você. Esses podem variar de aplicativos simples acionados por dados, como Zapier, a integrações de Business Intelligence em larga escala que extraem enormes quantidades de dados de várias fontes para análise. Saber como funciona uma API é o primeiro passo para construir grandes integrações.

Leia mais em blog-introduction.fr

Como usar a API?