Skip to content

Queue - Webhook Entradas

Endpoint para crear objetos en la cola de procesamiento relacionados con webhooks de entradas.

URLs

MétodoURLAcciónDescripción
POST/api/v1/integration/queueRegistrarCrea un objeto en la cola de procesamiento para webhook de entradas
GET/api/v1/integration/queue/{id}VisualizarVerifica el estado de procesamiento de un objeto en la cola

Producción:

{connect-producao}/api/v1/integration/queue

Homologación:

{connect-homologacao}/api/v1/integration/queue

Autenticación

Todas las solicitudes requieren un token de acceso obtenido en el endpoint de Security. El token debe ser enviado en el header AccessToken.

Crear Objeto en la Cola

Solicitud

Endpoint: POST {connect-producao}/api/v1/integration/queue

Headers:

AccessToken: {access_token}
Content-Type: application/json

Body:

json
{
  "action": "ticket-create",
  "data": {
    "datos_del_boleto": "valor",
    "datos_del_comprador": "valor"
  }
}

Respuesta de Éxito

Estado: 201 Created

json
{
  "id": "uuid-del-objeto",
  "created": "2025-01-01T00:00:00Z",
  "iCode": 0,
  "iMsg": "Objeto creado con éxito",
  "processDate": null,
  "processStatus": "pending",
  "processMsg": null
}

Verificar Procesamiento

Solicitud

Endpoint: GET {connect-producao}/api/v1/integration/queue/{id}

Headers:

AccessToken: {access_token}

Respuesta de Éxito

Estado: 200 OK

json
{
  "id": "uuid-del-objeto",
  "created": "2025-01-01T00:00:00Z",
  "iCode": 0,
  "iMsg": "Procesado con éxito",
  "processDate": "2025-01-01T00:05:00Z",
  "processStatus": "completed",
  "processMsg": "Procesamiento concluido",
  "msg": {
    "action": "ticket-create",
    "data": {
      "datos_del_boleto": "valor",
      "datos_del_comprador": "valor"
    }
  }
}

Campos de la Respuesta

CampoTipoDescripción
idstringIdentificador único del objeto en la cola
createddatetimeFecha de creación del objeto
iCodenumberCódigo de estado interno
iMsgstringMensaje de estado interno
processDatedatetime/nullFecha de procesamiento (null si aún no procesado)
processStatusstringEstado del procesamiento (pending, processing, completed, failed)
processMsgstring/nullMensaje de procesamiento
msgobjectDatos originales de la solicitud

Ejemplo de Implementación

javascript
async function crearWebhookEntrada(datosEntrada, accessToken) {
  const response = await fetch('{connect-producao}/api/v1/integration/queue', {
    method: 'POST',
    headers: {
      'AccessToken': accessToken,
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      action: 'ticket-create',
      data: datosEntrada
    })
  });

  if (!response.ok) {
    throw new Error(`Error ${response.status}: ${response.statusText}`);
  }

  const resultado = await response.json();
  return resultado.id;
}

async function verificarProcesamiento(queueId, accessToken) {
  const response = await fetch(`{connect-producao}/api/v1/integration/queue/${queueId}`, {
    method: 'GET',
    headers: {
      'AccessToken': accessToken
    }
  });

  if (!response.ok) {
    throw new Error(`Error ${response.status}: ${response.statusText}`);
  }

  return await response.json();
}

Documentación de la API Fanbase