Consulta de planes de alianzas (CSV)

Este endpoint permite exportar un archivo CSV con información del plan y métricas de uso de la cuenta autenticada y de sus cuentas de aliados. Es útil para monitorear, en un solo archivo, datos como el nombre de la cuenta, marca, plan actual, saldo de créditos, estado de la suscripción, período del plan y métricas de uso en el intervalo consultado.

Endpoint

GET https://api.zapsign.com.br/api/v1/info-plan/partners-csv/

Parámetros de Consulta (Query Parameters)

Nombre	Tipo	Descripción
start_date	string	Fecha inicial del periodo consultado (YYYY-MM-DD). Opcional.
end_date	string	Fecha final del periodo consultado (YYYY-MM-DD). Opcional.

Reglas del período:

• El intervalo máximo permitido es de 30 días.
• Si no se envían parámetros, el endpoint considera los últimos 30 días.
• Si solo se envía start_date, se asumirá end_date como la fecha actual.
• Si solo se envía end_date, se asumirá start_date como 30 días antes de la fecha final.

Encabezados (Headers)

• Authorization: Bearer SU_API_TOKEN

Columnas del CSV

El archivo contiene una fila para la cuenta autenticada y una para cada cuenta de aliado vinculada:

• id, name, brand_name: Identificación de la cuenta y marca.
• plan_name, credits, status: Nombre del plan, saldo y estado de la suscripción.
• period, current_period_end: Periodicidad y fecha de finalización del ciclo.
• Métricas de uso: documents_created, envelopes_created, qty_sms, qty_whatsapp, qty_digital_certificate, qty_biometry_sov, qty_facial_recognition, qty_identity_verification, qty_liveness.

Ejemplo de Solicitud (curl)

Bash

curl --request GET \
  --url 'https://api.zapsign.com.br/api/v1/info-plan/partners-csv/?start_date=2026-03-01&end_date=2026-03-04' \
  --header 'Authorization: Bearer SU_API_TOKEN'

Respuestas de Error

400 - Parámetros inválidos

Esto puede suceder cuando el formato de fecha es incorrecto, el intervalo excede los 30 días o la fecha inicial es posterior a la final.

JSON

{
  "non_field_errors": [
    "Date range cannot exceed 30 days"
  ]
}

401 - No autenticado

Ocurre cuando el token es inválido o no fue enviado.

JSON

{
  "detail": "Invalid API token."
}