Um percurso de leitura na documentação da API: do primeiro pedido à integração pronta

WhatsApp e APIs·· 53 visualizações· 3 min de leitura

A resposta curta: não precisa de ler a documentação toda. Para uma integração que funcione e não falhe ao primeiro problema, chegam oito paragens, por esta ordem. As cinco primeiras são iguais para qualquer projecto; as outras dependem do que vai automatizar.

O percurso, paragem a paragem

1 Começar com a API: confirme que a API responde com GET /v1/ping, que não pede chave, e veja o formato das respostas.
2 Autenticação e chaves: como a chave vai no cabeçalho Authorization e o que distingue uma chave sandbox_ de uma prod_.
3 Permissões: escolha só as que o seu programa precisa, área a área.
4 Regras da API: erros, limites, paginação, repetições com Idempotency-Key e os modos Sandbox e Produção. É a página que separa um programa que funciona de um que falha à primeira dificuldade.
5 A página da área que vai usar, no grupo Áreas do menu: lá estão a permissão necessária e cada operação com exemplos.
6 Playground: experimente as operações com uma chave sandbox_ antes de escrever código.
7 Chave e estado: as operações que o seu programa pode chamar para confirmar a ligação, ver os limites e acompanhar operações longas.
8 Produção: quando estiver tudo a funcionar, crie uma chave prod_ com as permissões mínimas. A secção «Passar para Produção» das Regras da API diz o que muda.

Por onde começar, conforme o projecto

Se quer... Leia primeiro
Mostrar preços e planos no seu site Catálogo
Enviar SMS a partir do seu sistema SMS
Enviar e-mails da sua aplicação Email Center
Gerir registos DNS DNS
Abrir pedidos de suporte a partir de um sistema Suporte
Consultar e pagar facturas com saldo Facturas e saldo
Saber se uma operação demorada já terminou Chave e estado
Não salte as Regras da API. Um programa que repete uma compra sem Idempotency-Key, que não espera depois de um 429, ou que lê só a primeira página de uma lista, causa problemas que a referência sozinha não explica.
Desde o primeiro dia, guarde a chave numa variável de ambiente chamada RLX_API_KEY: é a que todos os exemplos da documentação lêem, por isso pode copiá-los sem mexer em nada. Veja os exemplos de código.

O primeiro passo demora um minuto e não precisa de chave.

Começar com a API

VEJA TAMBÉM

Como está organizada a documentação da API: Começar, Áreas, Referência e Playground

O Playground da API: experimentar um pedido real a partir do navegador, passo a passo

Exemplos de código na documentação da API: curl, PHP, Python e JavaScript, prontos a adaptar

Ler uma operação na documentação da API: permissão, parâmetros, exemplos, respostas e erros

Enviar SMS pela API: chave, permissões, Sandbox e o primeiro pedido

PRODUTO RECOMENDADO

Hospedagem de sites com cPanel

Domínio e SSL incluídos, cópias diárias e o painel que já conhece. desde 396,00 MT/mês (plano de 3 anos, com cupão)

Ver planos
Esta resposta foi útil? A sua resposta ajuda-nos a melhorar este artigo.