gigstack API
    gigstack API
    • Welcome to gigstack API
    • gigstack Connect API Guide
    • Migrar de API v1 a v2 de gigstack
    • Clients
      • Clients API Guide
      • List clients
        GET
      • Get client
        GET
      • Update client
        PUT
      • Create client
        POST
      • Validate client fiscal information
        POST
      • Get client customer portal access token
        POST
      • Stamp pending receipts
        POST
      • Delete client
        DELETE
    • Services
      • Services API Guide
      • List services
        GET
      • Get service
        GET
      • Update service
        PUT
      • Create service
        POST
      • Delete service
        DELETE
    • Invoices
      • Invoices API Guide
      • Income
        • List income invoices
        • Get income invoice
        • Create income invoice
      • Egress
        • List egress invoices
        • Get egress invoice
        • Create egress invoice
      • Get invoice files
        GET
      • Cancel invoice
        DELETE
    • Payments
      • Payments API Guide
      • List payments
        GET
      • Get payment
        GET
      • Request payment
        POST
      • Register payment
        POST
      • Mark payment as paid
        POST
      • Refund payment
        POST
      • Cancel payment
        DELETE
    • Receipts
      • Receipts API Guide
      • List receipts
      • Get receipt
      • Create receipt
      • Stamp receipt
      • Cancel receipt
    • Teams
      • Teams API Guide
      • List teams
      • Get team
      • Get team integrations
      • Get team series
      • Get team onboarding URL
      • Update team
      • Update team series
      • Update team settings
      • Create team
      • Add team member
      • Remove team member
      • Create team series
    • Users
      • Users API Guide
      • List users
      • Get user
      • Update user
      • Create user
      • Reset user password
    • Catalogs
      • Tax Regimes Catalog (Régimen Fiscal)
      • Payment Forms | Formas de pago
      • CFDI Usage Catalog (Uso CFDI)
      • Payment Methods Catalog (Método de Pago)
      • Months and Bimesters Catalog (Meses y Bimestres)
      • Invoice Relationships Catalog (Relación entre Facturas)

    Migrar de API v1 a v2 de gigstack

    Guía de Migración: API v1 a v2 de gigstack#

    📋 Tabla de Contenidos#

    Resumen de Cambios
    Cambios en la URL Base
    Cambios en Autenticación
    Cambios en Estructura de Respuestas
    Cambios en Endpoints
    Nuevas Funcionalidades en v2
    Pasos para Migrar
    Ejemplos de Migración
    Deprecación de v1
    Recursos Adicionales

    🚀 Resumen de Cambios#

    La API v2 de gigstack representa una mejora significativa sobre v1, con mejor estructura, nuevas funcionalidades y mayor compatibilidad con CFDI 4.0. Los principales cambios incluyen:
    ✅ Nueva URL base más consistente
    ✅ Estructura de respuestas estandarizada
    ✅ Soporte completo para CFDI 4.0
    ✅ Paginación mejorada con cursores
    ✅ gigstack Connect para multi-tenant
    ✅ Validación EFOS integrada
    ✅ Mejor manejo de errores
    ✅ Webhooks más robustos

    🔗 Cambios en la URL Base#

    v1 (Antigua)#

    https://https://gigstack-cfdi-bjekv7t4.uc.gateway.dev/v1

    v2 (Nueva)#

    Production: https://api.gigstack.io/v2
    Staging: https://api.gigstack.io/v2 (usar API key de test)

    ⚠️ Acción Requerida#

    Actualiza todas las referencias a la URL base en tu código:
    Antes:
    Después:

    🔐 Cambios en Autenticación#

    v1#

    La autenticación en v1 utilizaba API Keys en formatos variados.

    v2#

    La autenticación ahora utiliza JWT tokens exclusivamente con el header Authorization.
    Formato requerido:

    📝 Cómo Obtener tu Token#

    1.
    Ingresa a app.gigstack.pro/settings?subtab=api
    2.
    Haz clic en "Generar nuevas llaves"
    3.
    Usa la API Key de test para staging y live para producción

    Ejemplo de Actualización#

    v1:
    v2:

    📦 Cambios en Estructura de Respuestas#

    Una de las mejoras más importantes en v2 es la estandarización de respuestas.

    v1 - Respuestas Inconsistentes#

    // Algunas respuestas devolvían el objeto directamente
    {
      "id": "client_123",
      "name": "Juan Pérez"
    }
    
    // Otras envolvían en diferentes estructuras
    {
      "success": true,
      "result": { ... }
    }

    v2 - Respuestas Estandarizadas#

    Todas las respuestas siguen la misma estructura:

    ✅ Respuesta Exitosa (Objeto Único)#

    {
      "message": "Description of action",
      "data": {
        "id": "client_123",
        "name": "Juan Pérez",
        "rfc": "XAXX010101000"
      }
    }

    📋 Respuesta de Lista (Paginada)#

    {
      "message": "Items retrieved successfully",
      "data": [
        { "id": "client_1", "name": "Cliente 1" },
        { "id": "client_2", "name": "Cliente 2" }
      ],
      "next": "cursor_for_next_page",
      "has_more": true,
      "total_results": 150
    }

    ❌ Respuesta de Error#

    {
      "message": "Error description",
      "error": "Specific error details"
    }

    ⚠️ Acción Requerida#

    Actualiza tu código para acceder a la propiedad data:
    Antes (v1):
    Después (v2):

    🔀 Cambios en Endpoints#

    Recursos Principales#

    Recursov1 Endpointv2 EndpointCambios
    Clientes/clients/clients✅ Sin cambios en ruta
    Servicios/products/services⚠️ Renombrado
    Facturas/invoices/invoices✅ Mejorado con CFDI 4.0
    Pagos/payments/payments✅ Refactorizado
    Equipos❌ No disponible/teams🆕 Nuevo
    Usuarios❌ No disponible/users🆕 Nuevo

    ⚠️ Cambio Importante: Products → Services#

    En v2, el recurso products se renombró a services para reflejar mejor el contexto mexicano de facturación.
    v1:
    v2:

    🆕 Nuevas Funcionalidades en v2#

    1. gigstack Connect (Multi-tenant)#

    Ahora puedes acceder a recursos de múltiples equipos dentro de la misma cuenta de facturación agregando el parámetro team:
    Requisitos:
    Tu API key debe pertenecer a un equipo con gigstack Connect habilitado
    El equipo objetivo debe compartir la misma cuenta de facturación

    2. Validación EFOS Automática#

    v2 incluye validación automática de clientes contra la lista de EFOS del SAT:
    {
      "message": "Client created successfully",
      "data": {
        "id": "client_123",
        "rfc": "XAXX010101000",
        "efos_status": "valid",
        "efos_checked_at": "2025-10-02T10:30:00Z"
      }
    }

    3. Paginación con Cursores#

    v2 utiliza paginación basada en cursores en lugar de offset/limit:
    v1 (Paginación Offset):
    v2 (Paginación con Cursor):
    Ventajas:
    Más eficiente para conjuntos grandes de datos
    Previene resultados duplicados durante actualizaciones
    Mejor rendimiento

    4. Soporte Completo CFDI 4.0#

    v2 está completamente actualizado para CFDI 4.0 con:
    Nuevos catálogos del SAT
    Complementos actualizados
    Validaciones mejoradas
    Timbrado más rápido

    5. Webhooks Mejorados#

    Eventos más granulares y payload más detallado:
    {
      "event": "invoice.stamped",
      "timestamp": "2025-10-02T10:30:00Z",
      "data": {
        "invoice_id": "inv_123",
        "uuid": "12345678-1234-1234-1234-123456789012",
        "status": "stamped",
        "pdf_url": "https://...",
        "xml_url": "https://..."
      }
    }

    🛠️ Pasos para Migrar#

    Paso 1: Preparación#

    1.
    Revisa tu código actual y haz una lista de todos los endpoints que usas
    2.
    Genera nuevos tokens JWT desde el panel de configuración
    3.
    Lee la documentación completa de v2: docs.gigstack.io

    Paso 2: Configuración del Entorno#

    1.
    Crea un ambiente de prueba usando tu API key de test
    2.
    Actualiza la URL base a https://api.gigstack.io/v2
    3.
    Actualiza los headers de autenticación a JWT Bearer tokens

    Paso 3: Actualiza tu Código#

    3.1 Actualiza la Autenticación#

    3.2 Actualiza el Manejo de Respuestas#

    3.3 Actualiza Endpoints Renombrados#

    3.4 Actualiza Paginación#

    Paso 4: Prueba Exhaustivamente#

    1.
    Prueba todos los flujos críticos en staging
    2.
    Verifica el manejo de errores con casos edge
    3.
    Compara resultados entre v1 y v2 si es posible
    4.
    Documenta cualquier discrepancia

    Paso 5: Deploy Gradual#

    1.
    Despliega primero en staging
    2.
    Monitorea logs y errores por 24-48 horas
    3.
    Realiza deploy a producción en horario de baja actividad
    4.
    Mantén rollback disponible por si surgen problemas

    💡 Ejemplos de Migración#

    Ejemplo 1: Crear Cliente#

    v1:
    v2:

    Ejemplo 2: Listar Facturas con Paginación#

    v1:
    v2:

    Ejemplo 3: Crear Servicio (antes Producto)#

    v1:
    v2:

    Ejemplo 4: gigstack Connect (Multi-team)#

    Nueva funcionalidad en v2:

    ⏰ Deprecación de v1#

    Línea de Tiempo#

    Hoy: v2 está disponible para todos los usuarios
    [Fecha TBD]: v1 entra en modo de mantenimiento (solo corrección de bugs críticos)
    [Fecha TBD]: v1 será descontinuada completamente

    Recomendaciones#

    ⚠️ Migra lo antes posible - v1 no recibirá nuevas funcionalidades y eventualmente será descontinuada.
    ✅ Planifica tu migración - Usa esta guía para crear un plan de migración estructurado.
    📧 Mantente informado - Suscríbete a las actualizaciones en app.gigstack.pro/settings.

    📞 Soporte y Recursos Adicionales#

    Documentación#

    Documentación completa v2: docs.gigstack.io
    Swagger UI interactivo: docs.gigstack.io/swagger
    Ejemplos de código: Disponibles en múltiples lenguajes en la documentación

    Colecciones y Herramientas#

    Colección de Postman v2: Solicita acceso a través de soporte
    Webhooks: Guía completa en docs.gigstack.io/webhooks
    SDK oficial: Próximamente disponible

    Soporte#

    Email: soporte@gigstack.io
    Chat en vivo: Disponible en app.gigstack.pro
    Documentación v1 (referencia): Ver documentación antigua en Postman

    Comunidad#

    GitHub Discussions: Para preguntas técnicas y mejores prácticas
    Changelog: Mantente al día con las últimas actualizaciones

    ✅ Checklist de Migración#

    Usa esta lista para asegurar una migración exitosa:

    Preparación#

    Revisé toda la documentación de v2
    Generé nuevos JWT tokens (test y producción)
    Identifiqué todos los endpoints que uso actualmente
    Creé un ambiente de staging para pruebas

    Código#

    Actualicé la URL base a https://api.gigstack.io/v2
    Cambié autenticación a Authorization: Bearer
    Actualicé manejo de respuestas para acceder a .data
    Renombré todos los endpoints /products a /services
    Implementé nueva paginación con cursores
    Agregué manejo de errores estandarizado

    Pruebas#

    Probé crear, leer, actualizar y eliminar recursos
    Verifiqué paginación con conjuntos grandes de datos
    Validé manejo de errores y casos edge
    Confirmé que webhooks funcionan correctamente
    Comparé resultados entre v1 y v2

    Deploy#

    Desplegué a staging y monitoré por 48 horas
    Documenté cualquier issue encontrado
    Realicé deploy a producción
    Configuré monitoreo de logs y errores
    Tengo plan de rollback preparado

    🎉 ¡Migración Exitosa!#

    Una vez completada la migración, disfrutarás de:
    ⚡ Mejor rendimiento con paginación optimizada
    🛡️ Mayor confiabilidad con estructura estandarizada
    🆕 Nuevas funcionalidades como gigstack Connect y validación EFOS
    📊 Mejor observabilidad con respuestas más claras
    🚀 Preparado para el futuro con CFDI 4.0 completo

    📚 Referencia: Documentación v1#

    Si necesitas consultar la documentación antigua de v1 para referencia durante tu migración:
    Ver Documentación v1 en Postman →
    Nota: Esta documentación se mantiene solo como referencia. Te recomendamos migrar a v2 lo antes posible.

    ¿Necesitas ayuda con tu migración? Contáctanos en soporte@gigstack.io o abre un ticket en app.gigstack.pro/support
    Última actualización: Octubre 2025
    Modified at 2025-10-02 21:01:16
    Previous
    gigstack Connect API Guide
    Next
    Clients API Guide
    Built with