Descripción del proyecto
TraducidoNuestra empresa ha construido una API REST que los desarrolladores asociados utilizan para integrarse con nuestra plataforma, pero la documentación actual está desactualizada y dispersa en wikis internos y hojas de cálculo antiguas. Estamos buscando un redactor técnico experimentado que pueda convertir nuestros puntos finales existentes en una referencia limpia y estructurada en la que los desarrolladores puedan confiar sin tener que enviar un correo electrónico a nuestro equipo de soporte cada vez que se quedan atascados.
El trabajo cubre cada punto final público: descripciones claras de lo que hace cada método, un desglose completo de los parámetros requeridos y opcionales con tipos y valores predeterminados, autenticación y manejo de errores, y ejemplos realistas de solicitudes y respuestas en JSON. Más allá de la referencia escrita, queremos una página de pruebas interactiva donde los desarrolladores asociados puedan introducir sus propias claves, enviar solicitudes de muestra y ver respuestas en vivo directamente en el navegador.
Podemos proporcionar acceso a un entorno de pruebas, notas internas existentes y comunicación directa con nuestros desarrolladores de backend para aclarar puntos finales complicados. El candidato ideal tiene experiencia práctica con APIs REST, JSON, esquemas de autenticación como tokens o claves de API, y herramientas para construir documentos interactivos. Por favor, comparte ejemplos de la documentación que has escrito antes, junto con un cronograma estimado.
Entregables:
— referencia estructurada para todos los puntos finales y parámetros
— ejemplos de solicitud y respuesta para cada método
— página de pruebas interactiva para desarrolladores asociados
— guía de incorporación corta para nuevos integradores
El trabajo cubre cada punto final público: descripciones claras de lo que hace cada método, un desglose completo de los parámetros requeridos y opcionales con tipos y valores predeterminados, autenticación y manejo de errores, y ejemplos realistas de solicitudes y respuestas en JSON. Más allá de la referencia escrita, queremos una página de pruebas interactiva donde los desarrolladores asociados puedan introducir sus propias claves, enviar solicitudes de muestra y ver respuestas en vivo directamente en el navegador.
Podemos proporcionar acceso a un entorno de pruebas, notas internas existentes y comunicación directa con nuestros desarrolladores de backend para aclarar puntos finales complicados. El candidato ideal tiene experiencia práctica con APIs REST, JSON, esquemas de autenticación como tokens o claves de API, y herramientas para construir documentos interactivos. Por favor, comparte ejemplos de la documentación que has escrito antes, junto con un cronograma estimado.
Entregables:
— referencia estructurada para todos los puntos finales y parámetros
— ejemplos de solicitud y respuesta para cada método
— página de pruebas interactiva para desarrolladores asociados
— guía de incorporación corta para nuevos integradores
Textos y traducción Efectivo, Transferencia bancaria
