Obtener Códigos de Acceso

Este método permite recuperar los códigos de acceso asociados a una transacción específica en el sistema de Experticket.

1. Método de Acceso

Parámetro

Descripción

URL

{baseurl}/api/transactionaccesscodes

Verbo HTTP

GET

Formato de Envío

application/json

⚠️ Importante:

  • La longitud máxima permitida de la URL es 2048 caracteres.
  • Se puede filtrar la consulta por SaleIdTransactionId (obsoleto) o por InternalCodes.

 

2. Datos de Envío

Campo

Descripción

ApiKey

Clave única y privada del colaborador.

TransactionId (obsoleto)

[Opcional] Identificador de la transacción.

SaleId

[Opcional] Identificador de la venta.

InternalCodes

[Opcional] Array de códigos internos asignados a los tickets.

api-version

Versión de la API a utilizar (por defecto 3.21).

 

3. Ejemplo de Petición

Solicitud con Parámetros en la URL

GET {baseurl}/api/transactionaccesscodes?ApiKey=xyz123&SaleId=965875680289&InternalCodes[0]=i54l54lkgfd

4. Estructura de la Respuesta

La respuesta incluirá un listado de transacciones y sus códigos de acceso.

Campo

Descripción

Transactions

Array de transacciones recuperadas.

Id

Identificador de la venta.

Products

Array de productos dentro de la transacción.

Id (Producto)

Identificador del producto.

Tickets

Array de tickets asociados a los productos.

Id (Ticket)

Identificador del ticket.

AccessCode

Código de acceso del ticket.

DeliveryState

Estado del proceso de entrega (1 = Pendiente2 = Enviado3 = Entregado).

InternalCode

[Opcional] Código interno del ticket.

InternalCodePartnerId

[Opcional] ID del colaborador que estableció el código interno.

InternalCodePartnerName

[Opcional] Nombre del colaborador que estableció el código interno.

InternalCodeDate

[Opcional] Fecha en la que se estableció el código interno.

Success

true si la consulta fue exitosa, false en caso contrario.

Timestamp

Fecha y hora de la respuesta.

ErrorMessage

Motivo del error (si Success = false).

ErrorCodes

Códigos de error en caso de fallo.

5. Ejemplo de Respuesta Exitosa

{

    "Transactions": [

        {

            "Id": "5194660864094625940",

            "Products": [

                {

                    "Id": "hjxdqsorbics1",

                    "Tickets": [

                        {

                            "Id": "eenqa37ajhuzq",

                            "AccessCode": "r4pbuqd7i7ync",

                            "DeliveryState": 1,

                            "InternalCode": "CustomCode1"

                        },

                        {

                            "Id": "11g6bijq395ha",

                            "AccessCode": "a85bu2dxiya15",

                            "DeliveryState": 1,

                            "InternalCode": "CustomCode2"

                        }

                    ]

                }

            ]

        }

    ],

    "Success": true,

    "Timestamp": "2021-02-18T17:02:27.8165916",

    "ErrorEntityBreakDown": []

}

6. Ejemplo de Respuesta con Error

{

    "Success": false,

    "ErrorMessage": "No se encontraron códigos de acceso para la transacción especificada.",

    "Timestamp": "2025-02-05T12:45:00.000Z",

    "ErrorCodes": [102],

    "ErrorEntityBreakDown": [

        {

            "Id": "965875680289",

            "Name": "Transaction Not Found"

        }

    ]

}

7. Consideraciones Finales

  • La ApiKey debe mantenerse en secreto y solo debe usarse en el servidor.
  • El SaleId es el identificador recomendado para realizar la consulta.
  • Si Success = false, revisar ErrorMessageErrorCodes para entender la causa del error.
  • El AccessCode obtenido puede utilizarse para el ingreso del cliente.

¿Te ha parecido útil este artículo?