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 entrada, a área que interessa, as regras e a especificação. E uma chave só para ele, se for preciso testar, nunca a sua.

O que enviar, conforme o trabalho

Para quê	O que enviar
Começar	A página inicial e Começar com a API.
Uma tarefa concreta	A página da área, ou a ligação directa à operação.
Uma integração que não falhe	As Regras da API.
Importar nas ferramentas dele	A especificação OpenAPI, que está no fim da Referência.
Trabalhar com um assistente de IA	O ficheiro llms.txt e as versões Markdown das páginas.

Ligar a uma secção ou a uma operação

Ao lado do título de cada secção há um símbolo de ligação: um clique copia o endereço dessa secção e aparece a mensagem «Ligação copiada». As operações têm o mesmo símbolo, e quem abrir a ligação chega com a operação já aberta. Assim, em vez de «veja a parte dos limites», envia exactamente o sítio.

A chave: uma para ele, nunca a sua

1	Crie uma chave própria para o programador, no My MozOut, na página API, com um nome que o identifique.

2	Comece em Sandbox: lê dados verdadeiros, mas as escritas são simuladas e nada é cobrado.

3	Dê só as permissões que o trabalho pede, e uma validade curta.

4	Quando o trabalho acabar, revogue-a. Para pôr o sistema a funcionar a sério, crie uma chave prod_ com as permissões mínimas.

Nunca envie a sua chave de produção por e-mail ou mensagem. Se uma chave andou por onde não devia, revogue-a e crie outra: o que fazer, pela ordem certa.

Na língua de quem vai programar

Se o programador preferir inglês, envie as ligações da versão inglesa, que tem o mesmo conteúdo: veja onde está cada língua.

Combine duas regras desde o início: a chave fica numa variável de ambiente, fora do código, e qualquer problema comunicado traz o X-Correlation-ID da resposta. Poupa dias de troca de mensagens.

Comece por enviar a página inicial da documentação.

Abrir a documentação

VEJA TAMBÉM

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

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

A documentação da API em português ou em inglês: onde está cada língua e como mudar

A documentação da API e a IA: o ficheiro llms.txt e dar a documentação inteira a um assistente

Uma chave de API ou um token ficou exposto: o que fazer, pela ordem certa

PRODUTO RECOMENDADO

Hospedagem de sites com cPanel

Domínio e SSL incluídos, cópias diárias e o painel que já conhece. desde 5.940,00 Kz/mês (plano de 3 anos, com cupão)

Ver planos

Categorias

Categorias