Seu guia sobre endpoints de API

As APIs podem ser difíceis de entender, especialmente se você não tem familiaridade com a criação de processos programáticos. Podemos contar um segredinho? As APIs são apenas maneiras de os aplicativos se comunicarem entre si e, se você souber como usá-las, elas poderão simplificar sua vida.

Se você está entrando agora no mundo das APIs de e-mail, ou APIs em geral, os endpoints de API podem parecer um pouco confusos no início. Um endpoint de API nada mais é do que um URL exclusivo que contém o nome de um servidor ou serviço. Ele identifica um local específico em uma interface de programação de aplicações (API).

Para usar um endpoint de API, você precisa fazer uma chamada ou solicitação de API. Mas podemos usar uma analogia rápida para mostrar como esses endpoints funcionam e como eles podem ser benéficos. Só um aviso: isso pode dar fome.

Ao descrever as APIs, é divertido imaginar um garçom em um restaurante. Você faz o pedido ao garçom (estamos pensando em um burrito delicioso), que leva seu pedido até a cozinha e depois traz sua comida. Nessa analogia, o cardápio é a documentação da API, que descreve as comidas e bebidas oferecidas pelo restaurante, e as opções do cardápio são os nossos endpoints de API.

O restaurante físico no qual você entra é como a API REST. Uma API REST (ou API RESTful) é apenas uma API que deve estar em conformidade com a arquitetura específica de um serviço ou aplicativo da web para que você possa interagir com ele com sucesso. Em outras palavras, você pode pedir burritos deliciosos nesse restaurante, mas não pode pedir comida chinesa, porque a cozinha não está preparada para fazer Frango Xadrez.

Para “fazer um pedido”, a pessoa desenvolvedora faz uma chamada de API (ou solicitação de API) que diz a um aplicativo para fazer algo; por sua vez, o aplicativo usa uma API para pedir a um servidor da web que faça algo. Existem diferentes tipos de métodos de API que você pode enviar com sua solicitação e que determinam o tipo de dados que você está manipulando:

• GET: recupera um recurso
• PATCH: atualiza um recurso
• PUT: substitui um recurso
• POST: cria um recurso
• DELETE: remove um recurso

Agora estamos com fome, mas também temos uma ideia básica de o que são APIs e como elas funcionam. Então, vamos falar sobre a função dos endpoints.

Os endpoints se parecem com qualquer URL com uma palavra ou um identificador adicionado no final, /endpoint.

O endpoint é o que queremos comer. Nosso pedido pode ser levado pelo garçom e preparado por quem cozinha, mas somos nós quem decidimos quais informações são enviadas. Como esteve no noticiário ultimamente, vamos usar a API do Twitter como exemplo.

Queremos pedir um novo tweet da API do Twitter e podemos fazer isso usando o endpoint /statuses/update deles.

O endpoint é onde a API se conecta ao sistema de backend do Twitter. Quando fazemos uma solicitação para o endpoint /statuses/update, o endpoint faz o trabalho de processar a solicitação (avisando a cozinha sobre o que queremos e como prepará-lo – neste caso, com texto personalizado) e de enviar uma resposta. As APIs permitem que você interaja com sites e serviços programaticamente.

Pode ser difícil ver o benefício dos endpoints de API quando você está criando apenas um único tweet, mas considere um cenário em que você escreve tweets para a sua clientela e eles precisam ser publicados em intervalos programados. O uso da API do Twitter permitiria que você configurasse isso e fizesse o marketing da sua clientela com eficiência.

Quase todas as soluções de SaaS e CPaaS oferecem uma API REST para a clientela, para que a equipe de desenvolvimento possa integrar o produto aos seus próprios aplicativos de software. Para acessar essas APIs, você precisa ser cliente dessa empresa, e as empresas geralmente usam a limitação de taxa para manter o uso da API justo. As OpenAPIs também existem, que são APIs públicas que qualquer pessoa desenvolvedora pode acessar.

Sempre que você troca ou solicita dados pela internet, é preciso se preocupar com monitoramento e segurança. A primeira camada de segurança da API é uma chave de API. As chaves de API são geradas pelo aplicativo ou projeto que faz a chamada, e podem restringir o uso a um ambiente ou a uma região de endereço IP específicos.

Como os endpoints estão fazendo todo o trabalho pesado, é importante que eles continuem seguros, ou então qualquer pessoa poderia acessar e alterar programaticamente os seus dados. A boa notícia é que você protege os endpoints com os mesmos métodos conhecidos que provavelmente já usa para proteger seus outros sistemas online.

Esses métodos incluem:

1. Autenticação básica/2FA
2. Criptografia
3. OAuth 2.0

As práticas recomendadas de segurança básica se aplicam à proteção das suas APIs e ambientes de desenvolvimento. Se você está procurando suas chaves e credenciais do Mailgun, pode encontrá-las aqui.

Como os endpoints são URLs, você pode – e deve – monitorá-los para garantir que continuem online. Ao falar sobre serviços e sites online, muitas vezes você ouvirá a palavra “uptime” (tempo de atividade). Essa é a porcentagem de tempo que seu aplicativo fica ativo – em outras palavras, a porcentagem de tempo que seu aplicativo está acessível e funcionando. Interrupções e erros de desempenho diminuirão sua porcentagem geral.

O monitoramento dos seus endpoints também fornece métricas sobre quais endpoints estão sendo acessados e quais tipos de chamadas de API a equipe de desenvolvimento está fazendo. Isso pode ajudar a rastrear o comportamento na sua base de usuários e obter insights sobre quais endpoints recebem alto tráfego, para que você possa manter o seu desempenho.

Como provedor de serviços de e-mail (ESP), o suporte da API do Mailgun é focado em soluções programáticas para tornar o seu programa de e-mail mais eficiente e bem-sucedido em grande escala. Nosso API de e-mailé um tipo específico de API que você pode usar para conectar seu aplicativo da web ou plataforma a um ESP para usar os recursos dele no seu próprio aplicativo.

Você deve estar se perguntando como, certo? O caso de uso mais versátil é o envio de e-mails transacionais ou baseados em gatilhos. Você pode usar a nossa API para configurar e-mails automáticos, como e-mails de confirmação de conta, redefinições de senha ou lembretes de carrinho de compras abandonado.

Estes são alguns dos nossos endpoints de API mais usados e o que eles fazem:

Os endpoints de API satisfazem grandes apetites de envio. Esses pontos de comunicação de processos facilitam a configuração de scripts programáticos para agilizar seu programa de e-mail, desde a configuração do envio de mensagens automatizadas ou transacionais até a recuperação de métricas e dados.

Se você envia e-mails com frequência em grande escala e não usa uma ferramenta de API de e-mail, seu programa de e-mail não está atingindo todo o seu potencial. Gerenciar diferentes tipos de e-mails e gatilhos transacionais, receber notificações de eventos importantes e extrair métricas são ingredientes cruciais para o seu crescimento, e tudo fica mais fácil com as APIs.

Quer mais conteúdo como este? Que bom, porque nós adoramos escrevê-lo. Junte-se a nós e desperte seu lado geek sobre e-mail assinando a nossa newsletter.

Autor: Em Blitstein Em Blitstein is a Sr. Content Marketing Manager at Sinch Mailgun. She manages the Mailgun Blog, curates top-notch content, and falls down SEO rabbit holes. She writes about all things email and loves a good dev deep dive.