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

PHP e Programação·· 50 visualizações· 3 min de leitura

A resposta curta: cada operação tem o mesmo pedido escrito em quatro linguagens: curl, PHP, Python e JavaScript. Todos lêem a chave da variável de ambiente RLX_API_KEY, por isso pode copiá-los sem colar a chave no código.

As quatro linguagens

Linguagem O que usa Onde corre
curl A linha de comandos. No terminal do Linux e do macOS. As linhas acabam em \, como no terminal. No PowerShell do Windows, escreva curl.exe numa só linha e troque $RLX_API_KEY por $env:RLX_API_KEY.
PHP A extensão cURL do PHP. No seu servidor ou na sua hospedagem.
Python A biblioteca requests. Onde tiver Python; instala-se com pip install requests.
JavaScript fetch, sem bibliotecas. No Node.js 18 ou mais recente, no servidor.

A chave nunca vai no código

Defina a variável uma vez, no ambiente onde o programa corre, e todos os exemplos passam a funcionar:

# Linux e macOS
export RLX_API_KEY="sandbox_..."

# PowerShell do Windows
$env:RLX_API_KEY="sandbox_..."

O PHP lê-a com getenv('RLX_API_KEY'), o Python com os.environ["RLX_API_KEY"] e o JavaScript com process.env.RLX_API_KEY.

Escolher a linguagem uma vez

Os exemplos estão em abas. Ao escolher um, todos os blocos da página mudam para essa linguagem, e a escolha fica lembrada no seu navegador para as páginas seguintes. Cada bloco tem um botão para copiar.

O que adaptar antes de usar

1 Os valores de exemplo: domínios, números de serviço e textos são de exemplo; troque-os pelos seus.
2 O Idempotency-Key dos POST: o exemplo traz um valor fixo. No seu programa, gere um identificador único para cada operação, e repita o mesmo só quando repetir essa mesma operação.
3 O Accept-Language: vem com a língua da página; mude se quiser as mensagens na outra língua.
4 O tratamento de erros: os exemplos só mostram o estado e o corpo. O seu programa deve ler o code do erro e decidir o que fazer.
Não ponha a chave no JavaScript de uma página do seu site. O navegador não consegue chamar a API fora da documentação, e quem abrisse a página via a chave. O exemplo de JavaScript é para correr no servidor, com Node.js.
O Node queixa-se do await? O exemplo usa await fora de uma função: grave o arquivo com a extensão .mjs, ou ponha o código dentro de uma função async. Para PHP, há mais pormenores em chamar uma API a partir do PHP com o cURL.

Os primeiros exemplos, prontos a copiar, estão em Começar com a API.

Ver os primeiros exemplos

VEJA TAMBÉM

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

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

Gerar um cliente da API para a sua linguagem a partir da nossa especificação OpenAPI

Chamar uma API web a partir do PHP com o cURL e ler a resposta em JSON

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

PRODUTO RECOMENDADO

Hospedagem de sites com cPanel

Domínio e SSL incluídos, cópias diárias e o painel que já conhece. desde R$ 36,30/mês (plano de 3 anos, com cupom)

Ver planos
Esta resposta foi útil? Sua resposta nos ajuda a melhorar este artigo.