API de Partners de Auphere · Primeros pasos
/ v0.1
Introducción
La API de Partners de Auphere permite que tu plataforma SaaS le dé a cada uno de tus clientes su propio agente de WhatsApp y sus campañas de plantillas — sin manejar credenciales de WhatsApp ni construir infraestructura de mensajería.
La API de Partners es una API HTTP común y corriente. Tu backend llama a api.auphere.com con una clave secreta y, para cada uno de tus clientes, puede:
- Provisionar un espacio de trabajo — un agente aislado, clonado de tu blueprint y personalizado con los valores que envíes.
- Conectar WhatsApp — vincular el número de WhatsApp Business propio de ese cliente vía Meta Embedded Signup.
- Gestionar administradores — definir qué teléfonos pueden hablar con el agente, y con qué permisos.
- Enviar campañas — plantillas aprobadas de WhatsApp con variables dinámicas, a un destinatario o a miles.
Modelo mental
Cada concepto de tu plataforma corresponde a uno en Auphere. Nunca manejas internals nuestros: siempre hablas con tus propios identificadores.
| En tu plataforma | En Auphere |
|---|---|
| Tu plataforma (el partner) | Una cuenta de partner con clave secreta (ak_live_…) |
| Un cliente / negocio en tu producto | Un espacio de trabajo aislado, referenciado solo por tu id (external_client_ref) |
| El WhatsApp del cliente | Un canal de WhatsApp Business Cloud API propio de ese cliente |
| El agente del cliente | Un agente clonado de tu blueprint al provisionar |
| Recordatorios masivos / avisos | Un envío de plantilla a 1..N destinatarios |
Dos scopes, dos capacidades
Cada endpoint exige uno de dos scopes, y tus claves pueden llevar uno o ambos. Están separados a propósito: dar de alta clientes es una capacidad de integración, mientras que escribirle a sus clientes finales tiene alcance real.
| Scope | Qué permite |
|---|---|
provision | Crear clientes, conectar su WhatsApp, gestionar administradores, leer el estado de onboarding |
broadcasts | Listar las plantillas aprobadas de un cliente y enviar campañas a sus contactos |
Pide una clave por capacidad si quieres que una clave de integración filtrada no pueda escribirle a nadie.
Aislamiento por construcción
Nunca nos envías un id de espacio de trabajo — no existe ese campo. Lo resolvemos a partir del par (tu identidad de partner, tu external_client_ref), y cada consulta corre bajo la seguridad a nivel de fila de ese espacio. Un cliente no puede ver datos de otro, ni un partner los de otro. La referencia de otro partner simplemente devuelve 404: no revelamos si existe.
Por dónde seguir
- Quickstart — tu primer cliente, de punta a punta, en cuatro llamadas.
- Provisionar clientes — el blueprint y sus placeholders.
- Referencia de API — todos los endpoints, campo por campo.