Documentação de APIDocumentação técnica

Documentação de API a partir das descrições dos seus endpoints

Normalmente fica pronto em 15 minutosAjustes incluídosControle de qualidade
Pacotes
Pagamento protegidoDetalhes
  • Os ajustes previstos no pacote são gratuitos.
  • Se você não responder em 3 dias após a entrega, o trabalho é aprovado automaticamente.

O dinheiro fica reservado no pagamento e só é liberado quando você aprova o trabalho.

Documentação de API a partir das descrições dos seus endpoints

Exemplo de resultado

Exemplo do pacote Padrão

Documentação de API: uma API de rastreio de encomendas para lojas online

Início rápido

  1. Pegue sua chave de API em Dashboard → Settings → API keys.
  2. Envie toda requisição com o cabeçalho Authorization: Bearer <your_key>.
  3. URL base: https://api.trackpoint.example/v1

Consultar uma remessa

GET /shipments/{tracking_number}

Retorna o status atual e o histórico de eventos de uma encomenda.

ParâmetroOndeObrigatórioDescrição
tracking_numberpathsimCódigo de rastreio da transportadora, 8–30 caracteres
langquerynãoIdioma dos textos de status: en, de, fr. Padrão: en

Exemplo de requisição

curl https://api.trackpoint.example/v1/shipments/JD014600006281 \
  -H "Authorization: Bearer sk_test_51x..."

Exemplo de resposta (200)

{
  "tracking_number": "JD014600006281",
  "status": "in_transit",
  "estimated_delivery": "2026-11-19",
  "events": [
    {"time": "2026-11-16T08:42:00Z", "location": "Leipzig hub", "status": "in_transit"}
  ]
}

Erros

CódigoSignificadoO que fazer
401Chave de API ausente ou erradaConfira o cabeçalho Authorization
404Código de rastreio não encontradoA transportadora pode levar até 2 horas para registrar uma encomenda nova
429Mais de 100 requisições por minutoAguarde o tempo indicado no cabeçalho Retry-After

Entregue

Documentação dos 14 endpoints em Markdown, pronta para o site de documentação do cliente, e uma lista de 3 pontos em que a API se comportou diferente das descrições, enviada aos desenvolvedores.

Cliente: Trackpoint, uma startup cuja API REST permite que lojas online mostrem o status de encomendas; os desenvolvedores mandaram descrições curtas de 14 endpoints e um conjunto de requisições de exemplo Tarefa: um guia de início rápido e uma referência de endpoints que um desenvolvedor consiga seguir em 15 minutos; abaixo, um trecho

O cliente e todos os dados são fictícios.

Sobre este serviço

Os desenvolvedores julgam uma API pela documentação em minutos: se a autenticação ou a primeira requisição não funcionar, eles vão embora. Escrevemos a referência e os guias da API a partir das descrições dos seus endpoints, do arquivo OpenAPI ou de exemplos de código: autenticação, URLs base, cada endpoint com parâmetros, exemplos de requisição e resposta, códigos de erro, limites de requisições e paginação. Um início rápido mostra a primeira chamada bem-sucedida em poucos passos.

O que está incluído

  • O que você recebeDocumentação da API em Markdown com blocos de código, pronta para ReadMe, GitBook, Docusaurus ou o seu repositório. Escrevemos a partir do que você envia e não chamamos a sua API.
  • Início rápidoDa chave de API à primeira chamada
  • Referência dos endpointsParâmetros, tipos, exemplos
  • Erros e limitesCódigos, significados, orientações para novas tentativas
  • Exemplos de códigocURL mais uma linguagem que você escolher
  • Termos consistentesOs mesmos nomes do seu schema

Como funciona

  1. 1
    BriefingVocê cola ou anexa endpoints e exemplos
  2. 2
    Estrutura e redaçãoEscrevemos a referência e os guias
  3. 3
    EntregaVocê recebe o Markdown pronto para publicar

O que precisamos de você

Descrições dos endpoints ou um arquivo OpenAPI ou Postman colado como texto, detalhes da autenticação, exemplos de requisições e respostas, códigos de erro e quem usa a sua API.

Vamos perguntar:

  • O que a API faz e quem a usa?
  • Como funciona a autenticação?
  • Qual linguagem os exemplos de código devem usar além de cURL?
  • Onde a documentação será publicada?

Compare os pacotes

PacotesBásicoR$ 106PadrãoR$ 217PremiumR$ 440
O que está incluídoInício rápido e até 5 endpointsAté 20 endpoints com guiasAté 50 endpoints, documentação completa
Prazo1 dia3 dias5 dias
Ajustes123
Tamanhoaté 2.000 palavrasaté 6.000 palavrasaté 14.000 palavras
Endpointsaté 5até 20até 50
Linguagens dos exemplos de códigocURLcURL + 1cURL + 2
Fazer pedido BásicoFazer pedido PadrãoFazer pedido Premium

Pagamento protegido

Você paga ao fazer o pedido, mas o dinheiro só é liberado pelo trabalho aprovado.

  • Preço fixoO preço do pacote não muda depois que você paga.
  • O dinheiro fica reservadoAo pagar, o valor fica apenas reservado. Ele só é repassado quando você aprova o trabalho.
  • Verificado antes da entregaCada resultado passa por um controle de qualidade antes de chegar até você, e você o vê na página do pedido antes de aprovar.
  • Ajustes gratuitosPeça ajustes dentro do seu briefing quantas vezes o pacote permitir.
  • Aprovação após 3 diasSe em 3 dias após a entrega você não aprovar o trabalho nem pedir ajustes, ele é aprovado automaticamente. Se você escrever no chat do pedido após a entrega, o pedido fica em espera; depois que respondermos, podemos reiniciar a contagem de 3 dias e avisaremos no chat.
  • Refazer ou reembolso totalSe o resultado não corresponder ao seu briefing e os ajustes não resolverem, ou se o trabalho levar mais que o dobro do prazo, escreva no chat do pedido: refazemos o trabalho ou reembolsamos o pagamento integralmente.
Como funciona →

Perguntas e respostas

Vocês podem trabalhar a partir da nossa especificação OpenAPI?

Sim, cole o YAML ou JSON no briefing. Transformamos as descrições em páginas de referência legíveis e preenchemos as lacunas que você apontar.

Vocês vão testar os exemplos?

Não chamamos a sua API. Os exemplos são montados a partir das suas amostras de requisição e resposta, então execute-os uma vez antes de publicar.

Vocês escrevem documentação de SDK?

Sim, se você enviar as assinaturas dos métodos e exemplos de uso. Cada SDK conta como parte do volume do pacote.

Não encontrou a resposta?

Pacotes