Python SDK

Herramientas para comunicarse con la API de Virtual Queue en proyectos de Python.

Repositorio

Puedes encontrar el repositorio en Github

O puedes ver el paquete en PyPi

Instalación

El método recomendado es instalar el paquete desde pypi

pip install vqueue-sdk

Uso básico

info

Puedes ver ejemplos en el repositorio

Un ejemplo básico del uso es el siguiente:

from vqueue import TokenVerifier
from vqueue.exceptions import VQueueApiError, VQueueError, VQueueNetworkError


def your_function_or_handler():
    # Obtén el token del request en tu sistema
    token = str(uuid4())  # Este es un UUIDv4 de ejemplo

    # Este objeto gestiona las conexiones en una sesión.
    # Es mejor reutilizar esta instancia para mejor performance.
    verifier = TokenVerifier()

    try:
        # Maneja el camino feliz
        verified_result = verifier.verify_token(token)
        print("The token was successfuly verified:", verified_result)
    except ValueError as ve:
        # Luego maneja los posibles errores que pueden surgir
        # Por supuesto, deberías manejar estas excepciones de manera más diligente en tu código
        print("The token is not valir UUID", ve)
    except VQueueNetworkError as ne:
        print("Network error", ne)
    except VQueueApiError as ae:
        print("The API returned an error status", ae)
    except VQueueError as vqe:
        print("A generic error with the Virtual Queue system or this SDK", vqe)

Métodos disponibles

TokenVerifier.__init__(self, *, verification_url: str | None = None)

Crea una instancia de verificador. Con el argumento opcional verification_url se puede especificar una url para la verificación.

TokenVerifier.verify_token(self, token: str) -> VerificationResult

Verifica el token y retorna un resultado en caso de que sea exitoso. Si la verificación no es exitosa se lanza una excepción:

• ValueError: Si el token no es un UUIDv4 válido.
• VQueueNetworkError: Si hay un error de conexión.
• VQueueApiError: Si la API responde con un código de error.
• VQueueError: Si hay algún error inesperado relacionado con la API.