Documentación de APIDocumentación técnica

Documentación de API a partir de las descripciones de sus endpoints

Suele estar listo en 15 minutosCambios incluidosControl de calidad
Paquetes
Protección de pagoDetalles
  • Los cambios dentro del paquete son gratuitos.
  • Si no responde en los 3 días siguientes a la entrega, el trabajo se acepta automáticamente.

El dinero queda reservado al pagar y solo se libera cuando usted acepta el trabajo.

Documentación de API a partir de las descripciones de sus endpoints

Ejemplo de resultado

Ejemplo del paquete Estándar

Documentación de API: una API de seguimiento de paquetes para tiendas en línea

Inicio rápido

  1. Consigue tu clave de API en Dashboard → Settings → API keys.
  2. Envía cada petición con la cabecera Authorization: Bearer <your_key>.
  3. URL base: https://api.trackpoint.example/v1

Obtener un envío

GET /shipments/{tracking_number}

Devuelve el estado actual y el historial de eventos de un paquete.

ParámetroDóndeObligatorioDescripción
tracking_numberpathsíNúmero de seguimiento del transportista, 8–30 caracteres
langquerynoIdioma de los textos de estado: en, de, fr. Por defecto, en

Ejemplo de petición

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

Ejemplo de respuesta (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"}
  ]
}

Errores

CódigoSignificadoQué hacer
401Falta la clave de API o es incorrectaRevisa la cabecera Authorization
404Número de seguimiento no encontradoEl transportista puede tardar hasta 2 horas en registrar un paquete nuevo
429Más de 100 peticiones por minutoEspera el tiempo indicado en la cabecera Retry-After

Entregado

Documentación de los 14 endpoints en Markdown, lista para el sitio de documentación del cliente, y una lista de 3 puntos donde la API se comportaba distinto a lo descrito, enviada a los desarrolladores.

Cliente: Trackpoint, una startup cuya API REST permite a las tiendas en línea mostrar el estado de un paquete; los desarrolladores enviaron descripciones breves de 14 endpoints y un conjunto de peticiones de ejemplo Tarea: una guía de inicio rápido y una referencia de endpoints que un desarrollador pueda seguir en 15 minutos; abajo, un fragmento

El cliente y todos los datos son ficticios.

Acerca de este servicio

Los desarrolladores juzgan una API por su documentación en cuestión de minutos: si la autenticación o la primera solicitud no funcionan, se van. Escribimos la referencia y las guías de la API a partir de las descripciones de sus endpoints, su archivo OpenAPI o ejemplos de código: autenticación, URL base, cada endpoint con sus parámetros, ejemplos de solicitud y respuesta, códigos de error, límites de frecuencia y paginación. Un inicio rápido muestra la primera llamada correcta en pocos pasos.

Qué incluye

  • Qué recibeDocumentación de API en Markdown con bloques de código, lista para ReadMe, GitBook, Docusaurus o su repositorio. Escribimos a partir de lo que nos envía y no llamamos a su API.
  • Inicio rápidoDe la clave de API a la primera llamada
  • Referencia de endpointsParámetros, tipos, ejemplos
  • Errores y límitesCódigos, significados, consejos para reintentar
  • Ejemplos de códigocURL más un lenguaje que elija
  • Términos coherentesLos mismos nombres que en su esquema

Cómo funciona

  1. 1
    BriefUsted pega o adjunta los endpoints y los ejemplos
  2. 2
    Estructura y redacciónEscribimos la referencia y las guías
  3. 3
    EntregaRecibe Markdown listo para publicar

Qué necesitamos de usted

Las descripciones de los endpoints o un archivo de OpenAPI o Postman pegado como texto, los detalles de autenticación, ejemplos de solicitudes y respuestas, los códigos de error y quiénes son los usuarios de su API.

Le preguntaremos:

  • ¿Qué hace la API y quién la usa?
  • ¿Cómo funciona la autenticación?
  • ¿Qué lenguaje deben usar los ejemplos de código además de cURL?
  • ¿Dónde se publicará la documentación?

Comparar paquetes

PaquetesBásico19 US$Estándar39 US$Premium79 US$
Qué incluyeInicio rápido y hasta 5 endpointsHasta 20 endpoints con guíasHasta 50 endpoints, documentación completa
Plazo1 día3 días5 días
Cambios123
Extensiónhasta 2.000 palabrashasta 6.000 palabrashasta 14.000 palabras
Endpointshasta 5hasta 20hasta 50
Lenguajes de los ejemplos de códigocURLcURL + 1cURL + 2
Hacer pedido BásicoHacer pedido EstándarHacer pedido Premium

Protección de pago

Usted paga al hacer el pedido, pero el dinero solo se libera por un trabajo aceptado.

  • Precio fijoEl precio del paquete no cambia después del pago.
  • El dinero queda reservadoAl pagar, el importe solo queda reservado. Pasa a Dleex cuando usted acepta el trabajo.
  • Revisado antes de la entregaCada resultado pasa un control de calidad antes de llegar a usted, y lo ve en la página del pedido antes de aceptarlo.
  • Cambios gratuitosSolicite cambios dentro de su brief tantas veces como permita el paquete.
  • Aceptación a los 3 díasSi en los 3 días siguientes a la entrega no acepta el trabajo ni solicita cambios, se acepta automáticamente. Si escribe en el chat del pedido después de la entrega, el pedido queda en espera; cuando le respondamos, podremos reiniciar el plazo de 3 días y se lo indicaremos en el chat.
  • Rehacer el trabajo o reembolso totalSi el resultado no se ajusta a su brief y los cambios no lo resolvieron, o el trabajo tarda más del doble de su plazo, escriba en el chat del pedido: rehacemos el trabajo o le reembolsamos el pago íntegro.
Cómo funciona →

Preguntas y respuestas

¿Pueden trabajar a partir de nuestra especificación OpenAPI?

Sí, pegue el YAML o el JSON en el brief. Convertimos sus descripciones en páginas de referencia legibles y completamos las lagunas que nos indique.

¿Probarán los ejemplos?

No llamamos a su API. Los ejemplos se construyen a partir de sus muestras de solicitudes y respuestas, así que ejecútelos una vez antes de publicar.

¿Escriben documentación de SDK?

Sí, si nos envía las firmas de los métodos y ejemplos de uso. Cada SDK cuenta como parte del volumen del paquete.

¿No encontró su respuesta?

Paquetes