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

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

A resposta curta: o menu lateral da documentação tem quatro grupos. Começar explica as regras que valem para tudo, Áreas tem uma página por parte da sua conta, a Referência da API junta todas as operações numa só página e o Playground serve para experimentar. Saber isto poupa voltas: cada dúvida tem um grupo certo.

Os quatro grupos do menu

Grupo O que tem Quando abrir
Começar Início, Começar com a API, Autenticação e chaves, Permissões e Regras da API. Antes do primeiro pedido, e sempre que tiver dúvidas sobre erros, limites, paginação, repetições ou os modos Sandbox e Produção.
Áreas Domínios, DNS, Alojamento, E-mail, Servidores, SMS, Email Center, Facturas e saldo, Conta e segurança, Catálogo, Suporte, Produtos extra, Revenda e Chave e estado. Quando vai automatizar uma tarefa concreta: cada página explica a área e lista as suas operações.
Referência da API Todas as operações numa só página, com filtro, cada uma a levar à página da sua área. Quando já sabe o que quer fazer e procura a operação certa.
Playground Todas as operações, prontas a experimentar. Para fazer um pedido real a partir do navegador e ver a resposta.

Pode abrir cada grupo pelo menu: Começar com a API, Referência da API e Playground.

O que tem cada página

1 No topo: o título, uma frase sobre o que a página cobre, dois botões de atalho (por exemplo, Playground e Ver a referência) e um cartão «Nesta página» com as secções.
2 Logo abaixo: a data «Actualizado em», o tempo de leitura e os botões Ver em Markdown e Copiar página.
3 O texto: dividido em secções, cada uma com uma ligação própria que pode copiar e enviar.
4 No fim: a caixa «Não encontrou o que procurava?», que leva à pesquisa e à Base de Conhecimento, e as ligações Anterior e Seguinte, pela ordem do menu.

Como as páginas se ligam entre si

As páginas de Começar explicam o que vale em todas as operações. As páginas das Áreas explicam cada operação e mandam para essas regras quando é preciso, em vez de as repetir. A Referência nasce da especificação OpenAPI, a mesma que a API usa: por isso a lista de operações acompanha o que a API aceita. Como ler uma área, ecrã a ecrã: a página de uma área.

Perdido? Em qualquer página, Ctrl+K (ou Cmd+K no Mac) abre a pesquisa. Veja como pesquisar na documentação.

Sabe o que quer fazer e procura a operação? Comece pela Referência.

Abrir a Referência da API

VEJA TAMBÉM

A nossa documentação da API: o que é, para quem é e como lá chegar

Ler a página de uma área na documentação da API: o guia, as operações e o filtro

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

Pesquisar na documentação da API: Ctrl+K, a tecla /, resultados por secção e pesquisas recentes

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

PRODUTO RECOMENDADO

Alojamento 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
Esta resposta foi útil? A sua resposta ajuda-nos a melhorar este artigo.