Tokenix API Client
Cliente Python para la API de Tokenix - Autenticación y comunicación HTTP completa.
Instalación
pip install tokenix-api-client
Dependencias
El paquete requiere las siguientes dependencias (se instalan automáticamente):
requests>=2.25.0- Para peticiones HTTPpython-dotenv>=0.19.0- Para variables de entorno (opcional)
Uso
Importar el cliente
from tokenix_api_client import create_auth_client
Obtener accessToken
# Crear cliente
auth_client = create_auth_client()
# Obtener accessToken
access_token = auth_client.get_access_token(
api_key="tu-api-key",
email_auth="email-para-primer-endpoint",
password_auth="password-para-primer-endpoint",
email_user="email-para-segundo-endpoint",
password_user="password-para-segundo-endpoint"
)
Realizar peticiones autenticadas
# Realizar petición HTTP autenticada
response = auth_client.make_request(
method="GET", # o "POST", "PUT", "DELETE"
endpoint="/v2/user/profile",
api_key="tu-api-key",
email_auth="email-para-primer-endpoint",
password_auth="password-para-primer-endpoint",
email_user="email-para-segundo-endpoint",
password_user="password-para-segundo-endpoint",
data={"key": "value"}, # opcional para POST/PUT
params={"param": "value"} # opcional para query parameters
)
Uso con context manager
with create_auth_client() as auth_client:
access_token = auth_client.get_access_token(**credentials)
response = auth_client.make_request("GET", "/v2/endpoint", **credentials)
Variables de Entrada
| Variable | Descripción | Ejemplo |
|---|---|---|
api_key |
Clave API de Tokenix | "xxx-xxx-xxxx" |
email_auth |
Email para primer endpoint de autenticación | "user+api@token-city.com" |
password_auth |
Password para primer endpoint de autenticación | "password123" |
email_user |
Email para segundo endpoint de autenticación | "user-manager@token-city.com" |
password_user |
Password para segundo endpoint de autenticación | "managerPassword123" |
Manejo de Errores
El paquete incluye manejo de errores específicos:
from tokenix_api_client import AuthError, InvalidCredentialsError, ServiceUnavailableError
try:
access_token = auth_client.get_access_token(**credentials)
except InvalidCredentialsError:
print("Credenciales inválidas")
except ServiceUnavailableError:
print("Servicio no disponible")
except AuthError:
print("Error de autenticación general")
Ejemplo Completo
from tokenix_api_client import create_auth_client
# Credenciales
credentials = {
"api_key": "tu-api-key",
"email_auth": "email-auth@token-city.com",
"password_auth": "password-auth",
"email_user": "email-user@token-city.com",
"password_user": "password-user"
}
# Usar cliente
with create_auth_client() as auth_client:
# Obtener token
token = auth_client.get_access_token(**credentials)
print(f"Token: {token}")
# Hacer petición
response = auth_client.make_request("GET", "/v2/user/profile", **credentials)
print(f"Status: {response.status_code}")
print(f"Data: {response.json()}")
Pruebas
Para probar el paquete localmente:
-
Copia el archivo de ejemplo:
cp test_auth.py.example test_auth.py
-
Edita las credenciales en
test_auth.py:- Reemplaza las credenciales de ejemplo con las reales
- NO subas
test_auth.pycon credenciales reales a PyPI
-
Ejecuta las pruebas:
python3 test_auth.py
⚠️ Importante: El archivo test_auth.py con credenciales reales debe mantenerse local y no subirse a repositorios públicos.
Metadata
Release files for tokenix-api-client 0.2.4
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| tokenix_api_client-0.2.4.tar.gz | 7.5 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| tokenix_api_client-0.2.4-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 14.6 kB
Release files / tokenix_api_client-0.2.4.tar.gz
| Download URL | tokenix_api_client-0.2.4.tar.gz |
|---|---|
| Size | 7.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
c2210b0629cae8a9f3ed1625d0e64db935960960934763c4947bd2fee773b42b
|
|
BLAKE2b-256 checksum How to use checksums |
689a29721ad84f8ed08d722a3f7e5165b7b498e6739817c5c94b360fdfa35498
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.10.12
|
Release files / tokenix_api_client-0.2.4-py3-none-any.whl
| Download URL | tokenix_api_client-0.2.4-py3-none-any.whl |
|---|---|
| Size | 7.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
54c90799bca76316364f93651468a77c5e2ff81a4862920297f4f60ef32908ef
|
|
BLAKE2b-256 checksum How to use checksums |
3fa1e52af87fd60e8fa415ef770e80772d859f84228bf3c424080f8fdf95b39f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.10.12
|