Angola
Brasil
Kenya
Moçambique
Nigeria
Portugal
South Africa
United Kingdom
United States
International
A resposta curta: cada operação da documentação tem sempre as mesmas secções, pela mesma ordem: Autenticação, Parâmetros, Corpo do pedido (quando há), Exemplos, Respostas, Campos da resposta e Erros. Aprendida a primeira, as outras lêem-se depressa.
As secções, uma a uma
| Secção | O que diz | Em que reparar |
| Autenticação | Se a operação precisa de chave e que permissão a chave tem de ter. | Sem essa permissão, a API responde 403 com o código insufficient_scope. |
| Parâmetros | Uma tabela com Nome, Onde, Tipo, Obrigatório e Descrição. | «Onde» diz se o valor vai no caminho, na consulta (depois do ?) ou num cabeçalho. |
| Corpo do pedido | Os campos JSON a enviar, com tipo e se são obrigatórios. | Só aparece nas operações que criam ou alteram alguma coisa. |
| Exemplos | O mesmo pedido em curl, PHP, Python e JavaScript. | A chave vem sempre da variável RLX_API_KEY, nunca escrita no código. |
| Respostas | Um separador por código de estado, com um exemplo em JSON. | Uma resposta com sucesso traz data e meta; um erro traz error. |
| Campos da resposta | O que quer dizer cada campo que volta. | Útil para saber o que guardar no seu sistema. |
| Erros | Uma tabela com Estado, Código e Significado. | O code não muda; a mensagem muda com a língua. |
Três pormenores que fazem diferença
|
|
|
| Os exemplos de resposta são só exemplos. Os números de serviço, os domínios e os valores da sua conta são outros. Nunca copie um identificador de um exemplo para um pedido real. |
| Quer as mensagens de erro em português? Envie o cabeçalho Accept-Language: pt. Os exemplos da documentação em português já o trazem. |
O significado de cada código de erro, e quais vale a pena repetir, está em Erros, nas Regras da API.
|
Antes de tratar erros no seu programa, leia a tabela completa dos códigos. Ver os códigos de erro |
PRODUTO RECOMENDADO Hospedagem de sites com cPanel Domínio e SSL incluídos, cópias diárias e o painel que já conhece. desde $6.60/mês (plano de 3 anos, com cupão) Ver planos |
