Skip to content

SDK de Python ​

El SDK oficial de Nimobase para Python (3.10+) es la alternativa al SDK TypeScript cuando tu integración corre en un servidor. Usa una clave secreta (sk_) y tiene paridad funcional con @nimobase/sdk/node.

Instalación ​

El paquete nimobase se instala desde PyPI:

bash
pip install nimobase

Primer cliente ​

Necesitas una clave secreta (sk_…) creada por un OWNER o ADMIN; consulta API Keys.

python
import os
from nimobase import Nimobase

client = Nimobase(secret_key=os.environ["NIMOBASE_SECRET_KEY"])

El SDK agrega el prefijo del contrato (/v1/…) por ti; si necesitas fijar la versión, usa version.

Entorno y versión ​

El cliente arranca en Producción. Para probar sin tocar datos reales, pasá sandbox=True:

python
client = Nimobase(secret_key=secret_key)                 # Producción
pruebas = Nimobase(secret_key=secret_key, sandbox=True)  # Sandbox

La versión del contrato se elige con version; si la omites, usas la última publicada:

python
fijado = Nimobase(secret_key=secret_key, version="v1")

Qué cambia y qué no entre entornos: Entornos.

Ejemplo de uso ​

python
from nimobase import NimobaseError, collect_all_pages

page = client.companies.list({"page": 1, "limit": 20})
print(page["data"], page["total"])

# Todas las páginas, sin perder filas (tope de 100 por petición)
all_companies = collect_all_pages(
    lambda page, limit: client.companies.list({"page": page, "limit": limit}),
)

try:
    client.companies.get("missing-id")
except NimobaseError as err:
    print(err.status_code, err.message, err.code)

Los listados devuelven el envelope del API (data, total, page, limit) y los errores HTTP 4xx/5xx se traducen a NimobaseError. Toma decisiones por err.code, no por el mensaje.

La autenticación usa el header X-API-Key con la clave secreta.

Módulos ​

El cliente expone los mismos módulos que el SDK TypeScript server: users, companies, settings, notifications, billing, invitations, entre otros. Los métodos y tipos de cada uno están en Funcionalidades y métodos.

Siguientes pasos ​