Auphere
Menú de documentación

Auphere Embed · Guías

/ v0.1

Provisionar clientes

Crea un workspace aislado de Auphere — con un agente listo — cada vez que un cliente se da de alta en tu producto.

Antes de que un cliente pueda conectar WhatsApp o enviar campañas, necesita un workspace del lado de Auphere. Lo creas con una sola llamada idempotente desde tu backend, normalmente donde tu producto crea el registro del cliente.

Tu blueprint de partner

Durante el alta, el equipo de Auphere configura un blueprint para tu cuenta de partner: qué vertical de agente reciben tus clientes (p. ej. un asistente de cobranza), qué connector vincula el agente con tu API, y si los clientes se activan automáticamente al conectar WhatsApp. La provisión clona ese blueprint para cada cliente nuevo — así cada cliente arranca con un agente probado, personalizado mediante placeholders que tú controlas.

Crear o actualizar un cliente

POST /v1/partners/clients es idempotente sobre external_client_ref: puedes llamarlo las veces que quieras con el mismo ref.

Request
POST https://api.auphere.com/v1/partners/clients
Authorization: Bearer ak_live_…
Content-Type: application/json

{
  "external_client_ref": "3f6c1a2e-9d41-4b7f-8f2a-0c5d9e1b7a44",
  "name": "Bodegón El Ávila",
  "timezone": "America/Caracas",
  "agent": {
    "placeholders": {
      "agent.name": "Mouna",
      "policies.admin_access.admin_phones": ["+584241234567"]
    }
  }
}
Response
{
  "external_client_ref": "3f6c1a2e-9d41-4b7f-8f2a-0c5d9e1b7a44",
  "status": "provisioned",
  "whatsapp": { "status": "not_connected", "display_phone_number": null },
  "agent": { "status": "provisioned" },
  "connector_connected": true
}
external_client_refstringRequerido
Tu id estable para el cliente. Lo volverás a usar al emitir tokens de sesión. No cambia nunca.
namestringRequerido
Nombre visible del negocio del cliente.
timezonestring
Timezone IANA, p. ej. America/Caracas. Se usa para scheduling y comportamiento en horario laboral.
agent.placeholdersobject
Valores para los placeholders del blueprint (nombre del agente, teléfonos admin, etc.). Las claves disponibles dependen de tu blueprint — te las compartimos en el alta. Un 422 te dice exactamente qué placeholder falta.
connectorobject
Credenciales y metadata del connector del blueprint, si tu blueprint usa uno — así el agente del cliente lee datos de tu API. Las credenciales se guardan cifradas.

Volver a llamar con el mismo ref

  • El agente del cliente nunca se re-crea — las personalizaciones posteriores a la provisión se preservan.
  • Las credenciales del connector se rotan a los valores que envíes. Úsalo para mantener tokens frescos.
  • La llamada nunca devuelve ids internos de Auphere. Tu external_client_ref es el único identificador que necesitas.