Artigos de Documentação e primeiros passos

Documentação e primeiros passos 352 O que é uma API, em palavras simples: pedidos, respostas e um exemplo REST A resposta curta: uma API é a forma combinada de um programa pedir coisas a outro. Em vez de uma pessoa abrir uma...
Documentação e primeiros passos 36 A nossa documentação da API: o que é, para quem é e como lá chegar A resposta curta: a documentação da API é o site onde explicamos, página a página, como ligar os seus programas à...
Documentação e primeiros passos 41 Como está organizada a documentação da API: Começar, Áreas, Referência e Playground A resposta curta: o menu lateral da documentação tem quatro grupos. Começar explica as regras que valem para tudo,...
Documentação e primeiros passos 39 Um percurso de leitura na documentação da API: do primeiro pedido à integração pronta A resposta curta: não precisa de ler a documentação toda. Para uma integração que funcione e não falhe ao primeiro...
Documentação e primeiros passos 46 Pesquisar na documentação da API: Ctrl+K, a tecla /, resultados por secção e pesquisas recentes A resposta curta: há um campo de pesquisa no menu lateral e outro na página inicial. Em qualquer página, Ctrl+K...
Documentação e primeiros passos 32 Ler a página de uma área na documentação da API: o guia, as operações e o filtro A resposta curta: cada área da API (Domínios, DNS, SMS, Facturas e saldo, e as outras) tem uma página com duas...
Documentação e primeiros passos 38 Ler uma operação na documentação da API: permissão, parâmetros, exemplos, respostas e erros A resposta curta: cada operação da documentação tem sempre as mesmas secções, pela mesma ordem: Autenticação,...
Documentação e primeiros passos 27 A documentação da API em Markdown: Ver em Markdown, Copiar página e para que servem A resposta curta: todas as páginas da documentação existem também em Markdown, texto simples com marcação leve. No...
Documentação e primeiros passos 50 A documentação da API e a IA: o ficheiro llms.txt e dar a documentação inteira a um assistente A resposta curta: na raiz da documentação há um ficheiro llms.txt: um índice em texto simples de todas as páginas,...
Documentação e primeiros passos 35 Resumir com IA e Partilhar na documentação da API: o que fazem e quando confiar na resposta A resposta curta: no topo das páginas da documentação há uma linha «Resumir com IA», com botões para ChatGPT,...
Documentação e primeiros passos 35 A documentação da API em português ou em inglês: onde está cada língua e como mudar A resposta curta: toda a documentação existe em português e em inglês, página a página. O selector de língua no topo...
Documentação e primeiros passos 34 Da documentação da API à sua conta e de volta: a página API, as chaves e o suporte A resposta curta: a documentação explica; o Meu Interweb é onde age. As chaves da API criam-se, vêem-se e revogam-se...
Documentação e primeiros passos 31 Entregar a documentação da API a um programador: ligações a secções, Markdown e a especificação A resposta curta: não precisa de explicar a API a quem vai programar. Basta enviar as ligações certas: a página de...