A resposta curta: há um campo de pesquisa no menu lateral e outro na página inicial. Em qualquer página, Ctrl+K (Cmd+K no Mac) ou a tecla / abrem a janela de pesquisa. Os resultados levam à página, à seção certa dentro da página, ou diretamente a uma operação.
O que a pesquisa encontra
| Resultado |
Como aparece |
| Páginas |
Pelo título e pelo texto: «permissões» leva à página Permissões. |
| Seções |
O resultado mostra a página e a seção, e abre já nessa seção. |
| Operações |
Nas áreas, cada operação é um resultado próprio. Pode procurar pelo nome, como «enviar um SMS», ou pelo método e caminho, como POST /v1/sms/messages. |
Como a pesquisa decide
| 1 |
Todas as palavras contam: um resultado só aparece se tiver todas as palavras que escreveu. Se não aparecer nada, tire uma palavra.
|
|
| 2 |
Acentos e maiúsculas não importam: «Domínios», «domínios» e «dominios», sem acento, dão o mesmo.
|
|
| 3 |
O título pesa mais: uma palavra no título de uma página vale mais do que no meio do texto, por isso o resultado mais provável vem primeiro. A janela mostra também quantos resultados encontrou.
|
|
As teclas
| Tecla |
O que faz |
| Ctrl+K ou Cmd+K |
Abre a pesquisa, ou fecha-a se já estiver aberta. |
| / |
Abre a pesquisa, quando não está escrevendo num campo. |
| Setas para cima e para baixo |
Escolhem o resultado. |
| Enter |
Abre o resultado escolhido. |
| Esc |
Fecha a janela. |
Pesquisas recentes e sugestões
Com o campo vazio, a janela mostra as suas pesquisas recentes e algumas sugestões. As pesquisas recentes ficam só no seu navegador, não conosco, e pode limpá-las. Uma pesquisa que pareça uma chave da API, começada por sandbox_ ou prod_, nunca fica guardada: é a proteção para o dia em que colar a chave no lugar errado.
Uma pesquisa por língua
Cada língua tem o seu índice: na documentação em português pesquisa-se em português. Os nomes técnicos (campos, cabeçalhos, códigos de erro, permissões) estão em inglês nas duas versões, e encontram-se em qualquer uma.
|
Procure pelo que vê na tela. Um código de erro como insufficient_scope, um cabeçalho como Idempotency-Key ou uma permissão como dns:write levam diretamente à explicação.
|
Há mais dois filtros, para quando já está no lugar certo: nas páginas das áreas com muitas operações, «Filtrar as operações desta área»; no Playground, «Pesquisar operação». Veja como ler a página de uma área.
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 cupom) Ver planos |
Angola
Brasil
Kenya
Moçambique
Nigeria
Portugal
South Africa
United Kingdom
United States
International
