bhexpress.api_client package

Subpackages

Module contents

class bhexpress.api_client.ApiBase(api_token=None, api_url=None, api_version=None, api_raise_for_status=True)

Bases: ABC

Clase base para las clases que consumen la API (wrappers).

Parámetros:

  • api_token (str) – Token de autenticación para la API.

  • api_url (str) – URL base para la API.

  • api_version (str) – Versión de la API.

  • api_raise_for_status (bool) – Si se debe lanzar una excepción

automáticamente para respuestas de error HTTP. Por defecto es True.

class bhexpress.api_client.ApiClient(token=None, url=None, version=None, raise_for_status=True)

Bases: object

Cliente para interactuar con la API de BHExpress.

Parámetros:

token (str) – Token de autenticación del usuario. Si no se proporciona,

se intentará obtener de una variable de entorno. :param str url: URL base de la API. Si no se proporciona, se usará una URL por defecto. :param str version: Versión de la API. Si no se proporciona, se usará una versión por defecto. :param bool raise_for_status: Si se debe lanzar una excepción automáticamente para respuestas de error HTTP. Por defecto es True.

delete(resource, headers=None)

Realiza una solicitud DELETE a la API.

Parámetros:

  • resource (str) – Recurso de la API a solicitar.

  • headers (dict) – Cabeceras adicionales para la solicitud.

Devuelve:

Respuesta de la solicitud.

Tipo del valor devuelto:

requests.Response

get(resource, headers=None)

Realiza una solicitud GET a la API.

Parámetros:

  • resource (str) – Recurso de la API a solicitar.

  • headers (dict) – Cabeceras adicionales para la solicitud.

Devuelve:

Respuesta de la solicitud.

Tipo del valor devuelto:

requests.Response

post(resource, data=None, headers=None)

Realiza una solicitud POST a la API.

Parámetros:

  • resource (str) – Recurso de la API a solicitar.

  • data (dict) – Datos a enviar en la solicitud.

  • headers (dict) – Cabeceras adicionales para la solicitud.

Devuelve:

Respuesta de la solicitud.

Tipo del valor devuelto:

requests.Response

put(resource, data=None, headers=None)

Realiza una solicitud PUT a la API.

Parámetros:

  • resource (str) – Recurso de la API a solicitar.

  • data (dict) – Datos a enviar en la solicitud.

  • headers (dict) – Cabeceras adicionales para la solicitud.

Devuelve:

Respuesta de la solicitud.

Tipo del valor devuelto:

requests.Response

exception bhexpress.api_client.ApiException(message, code=None, params=None)

Bases: Exception

Excepción personalizada para errores en el cliente de la API.