Zettana API Docs

API v1

Planes

Consulta el plan actual del usuario y sus permisos y límites asociados.

Qué es un plan en Zettana

En Zettana, el plan define los permisos y límites operativos disponibles para la cuenta actual.

Con este endpoint puedes:

  • consultar el plan actual
  • consultar permisos habilitados para la cuenta
  • ver límites y contadores de descargas
  • ver límites y contadores de sincronizaciones

Endpoint

  • GET /v1/plans

Objeto plan

La respuesta usa un objeto con esta estructura:

  • id: identificador interno del plan
  • name: nombre del plan
  • userId: identificador del usuario asociado
  • canUseApi: indica si la cuenta tiene acceso a la API
  • canUseRecurringSyncs: indica si la cuenta puede crear programaciones de sincronización recurrente
  • downloadLimit: límite de descargas disponibles para la cuenta
  • downloadCount: cantidad de descargas consumidas
  • syncRequestLimit: límite de solicitudes de sincronización
  • syncRequestCount: cantidad de solicitudes de sincronización consumidas

Obtener el plan actual

GET /v1/plans

Devuelve el plan actual de la cuenta autenticada.

Ejemplo

import requests

BASE_URL = "https://backend.zettana.com/v1"
API_KEY = "REEMPLAZA_CON_TU_API_KEY"

response = requests.get(
    f"{BASE_URL}/plans",
    headers={"x-api-key": API_KEY},
    timeout=30,
)

response.raise_for_status()
print(response.json())

Campos de salida

Este endpoint responde con un objeto plan. Sus campos están descritos en la sección Objeto plan.

Ejemplo de salida

{
  "id": "b85f4f5a-35a0-4a39-bb58-18b72f8d6d1c",
  "name": "FREE",
  "userId": "d4aa2a65-b13a-4ccf-9787-8a3a399a1d9d",
  "canUseApi": true,
  "canUseRecurringSyncs": false,
  "downloadLimit": 200,
  "downloadCount": 14,
  "syncRequestLimit": 30,
  "syncRequestCount": 3
}
Contactenos