API Reference

Documentación técnica para integrar GetMan con tus herramientas y flujos de trabajo.

Autenticación

Todas las peticiones a la API de GetMan requieren autenticación mediante Bearer Token. Puedes generar tu token de API desde la configuración de tu cuenta. 

curl -X GET "https://tu-getman.com/api/collections" \
  -H "Authorization: Bearer tu-token-de-api" \
  -H "Accept: application/json"

URL Base

https://getman.ceballosleon.com/api

Todas las rutas de la API son relativas a esta URL base.

Colecciones

GET /collections

Obtiene todas las colecciones del usuario autenticado.

Respuesta de ejemplo:

{
  "data": [
    {
      "id": 1,
      "name": "Mi API",
      "description": "Colección de mi API",
      "slug": "mi-api-abc123",
      "is_public": false,
      "created_at": "2025-01-01T00:00:00Z"
    }
  ]
}
GET /collections/{id}

Obtiene una colección específica con sus carpetas y peticiones.

Parámetros de URL:

Parámetro Tipo Descripción
id integer ID de la colección
POST /collections

Crea una nueva colección.

Body (JSON):

{
  "name": "Nueva Colección",
  "description": "Descripción opcional"
}

Parámetros:

Campo Tipo Requerido Descripción
name string Sí Nombre de la colección
description string No Descripción de la colección
POST /collections/import

Importa una colección desde JSON (Postman, Bruno o GetMan).

Body (JSON):

{
  "data": { /* Estructura de la colección */ },
  "format": "getman"
}

Consulta la guía de importación para ver la estructura completa del JSON.

Peticiones

POST /collections/{collectionId}/requests

Crea una nueva petición en una colección.

Body (JSON):

{
  "name": "Obtener usuarios",
  "method": "GET",
  "url": "{{base_url}}/api/users",
  "description": "Lista todos los usuarios",
  "headers": [
    {"key": "Accept", "value": "application/json", "enabled": true}
  ],
  "params": [],
  "body_type": "none",
  "body": null,
  "folder_id": null
}
PUT /requests/{id}

Actualiza una petición existente.

DELETE /requests/{id}

Elimina una petición.

Carpetas

POST /collections/{collectionId}/folders

Crea una nueva carpeta en una colección.

Body (JSON):

{
  "name": "Autenticación",
  "description": "Endpoints de autenticación",
  "parent_id": null
}

Errores

La API utiliza códigos de estado HTTP estándar para indicar el éxito o fracaso de las peticiones.

Código Nombre Descripción
200 OK La petición fue exitosa
201 Created El recurso fue creado exitosamente
400 Bad Request La petición tiene errores de sintaxis o parámetros inválidos
401 Unauthorized Token de autenticación inválido o ausente
403 Forbidden No tienes permiso para acceder a este recurso
404 Not Found El recurso solicitado no existe
422 Validation Error Los datos enviados no pasan la validación
429 Too Many Requests Has excedido el límite de peticiones
500 Server Error Error interno del servidor

Formato de Error

{
  "message": "Descripción del error",
  "errors": {
    "campo": ["Error de validación específico"]
  }
}

Límites de Tasa

La API tiene límites de tasa para proteger el servicio. Los límites actuales son:

  • 60 peticiones por minuto para la mayoría de endpoints
  • 10 peticiones por minuto para importación de colecciones

Los headers de respuesta incluyen información sobre tu uso actual: 

X-RateLimit-Limit: 60
X-RateLimit-Remaining: 58
X-RateLimit-Reset: 1704067200

¿Necesitas ayuda?

Si tienes preguntas sobre la API o encuentras algún problema, no dudes en contactarnos.

Contactar Soporte