Endpoints de la Cola
Puedes acceder a todas las funciones de la cola a través de los siguientes endpoints:| Endpoint | Método | Descripción |
|---|---|---|
| api.port.moda/v1/queue/{model-id} | POST | Agrega una solicitud a la cola |
| api.port.moda/v1/queue/requests/{request_id}/status | GET | Recupera el estado de una solicitud |
| api.port.moda/v1/queue/requests/{request_id}/status/stream | GET | Transmite el estado hasta su finalización |
| api.port.moda/v1/queue/requests/{request_id} | GET | Obtiene la respuesta de una solicitud |
| api.port.moda/v1/queue/requests/{request_id}/cancel | PUT | Cancela una solicitud |
request_id:
request_id y proporciona URLs para verificar el estado, cancelar o recuperar la respuesta, agilizando tu flujo de trabajo sin necesidad de desarrollar endpoints adicionales.
Estado de la Solicitud
Para monitorear el progreso de tu solicitud, usa el endpoint proporcionado con tu ID de solicitud único. Esto te permite rastrear el estado, la posición en la cola o recuperar la respuesta una vez que esté lista.Uso del Endpoint
Respuesta de Ejemplo
Cuando tu solicitud está en la cola, recibirás una respuesta como esta:Posibles Estados
Tu solicitud puede estar en uno de tres estados:-
IN_QUEUE: Indica que la solicitud está esperando ser procesada.
queue_position: Muestra tu lugar en la cola.response_url: URL para recuperar la respuesta una vez que se complete el procesamiento.
-
IN_PROGRESS: La solicitud se está procesando actualmente.
logs: Registros detallados (si están habilitados) que muestran los pasos del procesamiento.response_url: Dónde estará disponible la respuesta final.
-
COMPLETED: El procesamiento ha finalizado.
logs: Registros que detallan todo el proceso.response_url: Enlace directo a tu respuesta completada.
Habilitando los Registros
Los registros proporcionan información sobre el procesamiento de la solicitud. Están deshabilitados por defecto, pero se pueden habilitar con un parámetro de consulta:message: Descripción del evento.level: Gravedad (p. ej., INFO, ERROR).source: Origen del registro.timestamp: Hora en que se generó el registro.
Monitoreo en Tiempo Real
Para actualizaciones continuas, usa el endpoint de transmisión:text/event-stream hasta que se complete la solicitud.
Cancelando Solicitudes
Si tu solicitud todavía está en cola, puedes cancelarla con:Recuperando Respuestas
Una vez que tu solicitud estéCOMPLETED, recupera la respuesta usando:
Integración Simplificada con el Cliente de Port
El cliente de Port automatiza el seguimiento del estado, simplificando el desarrollo de aplicaciones con las funciones de Port.Límites de Tasa
Para garantizar un uso justo y la estabilidad del sistema, nuestros endpoints de API están sujetos a los siguientes límites de tasa:| Tipo de Endpoint | Límite de Tasa | Límite de Ráfaga |
|---|---|---|
| Enviar a la Cola | 10 solicitudes/segundo | 100 solicitudes/minuto |
| Todos los demás Endpoints | 100 solicitudes/segundo | 1,800 solicitudes/minuto |
403 Forbidden. Recomendamos implementar un mecanismo de reintento con retroceso exponencial para manejar estos casos.