Descrição do projeto
TraduzidoNossa empresa construiu uma API REST que os desenvolvedores parceiros usam para integrar com nossa plataforma, mas a documentação atual está desatualizada e espalhada por wikis internas e planilhas antigas. Estamos procurando um redator técnico experiente que possa transformar nossos endpoints existentes em uma referência limpa e estruturada que os desenvolvedores possam confiar sem precisar enviar e-mails para nossa equipe de suporte toda vez que ficarem presos.
O trabalho abrange todos os endpoints públicos: descrições claras do que cada método faz, uma análise completa dos parâmetros obrigatórios e opcionais com tipos e valores padrão, autenticação e tratamento de erros, e exemplos realistas de requisições e respostas em JSON. Além da referência escrita, queremos uma página de teste interativa onde os desenvolvedores parceiros possam inserir suas próprias chaves, enviar requisições de exemplo e ver respostas ao vivo diretamente no navegador.
Podemos fornecer acesso a um ambiente de staging, notas internas existentes e comunicação direta com nossos desenvolvedores de backend para esclarecer endpoints complicados. O candidato ideal tem experiência prática com APIs REST, JSON, esquemas de autenticação como tokens ou chaves de API, e ferramentas para construir documentos interativos. Por favor, compartilhe exemplos de documentação que você já escreveu antes, juntamente com um cronograma estimado.
Entregáveis:
— referência estruturada para todos os endpoints e parâmetros
— exemplos de requisições e respostas para cada método
— página de teste interativa para desenvolvedores parceiros
— guia de integração curto para novos integradores
O trabalho abrange todos os endpoints públicos: descrições claras do que cada método faz, uma análise completa dos parâmetros obrigatórios e opcionais com tipos e valores padrão, autenticação e tratamento de erros, e exemplos realistas de requisições e respostas em JSON. Além da referência escrita, queremos uma página de teste interativa onde os desenvolvedores parceiros possam inserir suas próprias chaves, enviar requisições de exemplo e ver respostas ao vivo diretamente no navegador.
Podemos fornecer acesso a um ambiente de staging, notas internas existentes e comunicação direta com nossos desenvolvedores de backend para esclarecer endpoints complicados. O candidato ideal tem experiência prática com APIs REST, JSON, esquemas de autenticação como tokens ou chaves de API, e ferramentas para construir documentos interativos. Por favor, compartilhe exemplos de documentação que você já escreveu antes, juntamente com um cronograma estimado.
Entregáveis:
— referência estruturada para todos os endpoints e parâmetros
— exemplos de requisições e respostas para cada método
— página de teste interativa para desenvolvedores parceiros
— guia de integração curto para novos integradores
Textos e tradução Dinheiro, Transferência bancária
