Guías del producto

API keys

Para usar la API de Wbiztool, o una integración que te pida tus credenciales, necesitas tres datos del panel:

Credencial	Campo de la API	Dónde encontrarla
ID de Cliente API (API Client ID)	`client_id`	Configuración → Claves API, en la parte superior de la página
API key	`api_key`	Configuración → Claves API
ID de Cliente WhatsApp (WhatsApp Client ID)	`whatsapp_client`	La columna ID de Cliente WhatsApp en la configuración de WhatsApp

Antes de empezar#

Debes ser Administrador del espacio de trabajo para ver, crear o eliminar API keys. Consulta Roles y permisos.
Selecciona primero el espacio de trabajo correcto. Las claves pertenecen al espacio de trabajo que está seleccionado cuando las creas, y las solicitudes a la API hechas con una clave actúan sobre ese espacio de trabajo. Consulta Cambiar de espacio de trabajo.
Las cuentas de demostración no pueden usar la API.

Encontrar tu API Client ID#

Abre Configuración → Claves API. La tarjeta Resumen de API muestra ID de Cliente API: seguido de un número. Usa ese número como client_id en todas las solicitudes. Es el mismo para todas las claves del espacio de trabajo.

Crear una API key#

Abre Claves API
Ve a Configuración y haz clic en la pestaña Claves API, o abre directamente /settings/#api-keys.
Crea la clave
En Nueva Clave API, haz clic en Crear Nuevo. Un mensaje confirma que se generó la clave, y esta aparece en la tabla.
Copia la clave completa
La columna Clave API solo muestra el principio y el final de cada clave. Haz clic en el botón de copiar que está junto a ella (Copiar Clave API Completa) para copiar la clave completa y pégala en tu app o integración.

Las claves reciben un nombre automático según cuántas claves tiene el espacio de trabajo (API Key 1, API Key 2, etc.) y no se pueden renombrar. Después de eliminar una clave, una clave nueva puede recibir el mismo nombre que una existente, así que distingue las claves por sus primeros y últimos caracteres y por la fecha Creado. Las claves no caducan: una clave funciona hasta que la eliminas.

Límite#

Un espacio de trabajo puede tener hasta 10 API keys a la vez. Cuando llegas al límite, verás "You have reached the maximum limit of 10 API keys per organization." (alcanzaste el límite máximo de 10 API keys por organización). Elimina una clave que ya no uses para crear una nueva.

La tabla de API keys#

Columna	Significado
Etiqueta	El nombre de la clave, como API Key 1.
Clave API	Los primeros y últimos caracteres de la clave. Usa el botón de copiar para obtener la clave completa.
Creado	La fecha en que se creó la clave.
Estado	Siempre Activo. Las claves eliminadas desaparecen de la tabla.
Acciones	Eliminar borra la clave.

Eliminar una API key#

Busca la clave
En Configuración → Claves API, busca la clave en la tabla.
Elimínala
Haz clic en Eliminar y luego en Sí, Eliminar Clave API.

La eliminación de una clave no se puede deshacer. Cualquier app que la siga usando deja de funcionar de inmediato y recibe Auth Error: invalid api key. Actualiza primero tus apps con una clave nueva.

WhatsApp Client ID#

Cada número de WhatsApp conectado tiene su propio ID. La mayoría de los endpoints de mensajería lo necesitan en el campo whatsapp_client para elegir qué número envía el mensaje.

Abre la configuración de WhatsApp y consulta la columna ID de Cliente WhatsApp junto a cada número. Consulta Conecta tu número de WhatsApp si todavía no has conectado ninguno.

Probar tus credenciales#

Llama a Comprobar credenciales (POST /api/v1/me/) con tu client_id y tu api_key, y opcionalmente un whatsapp_client. Confirma que funcionan juntos sin enviar nada ni consumir mensajes. Si el whatsapp_client no pertenece al espacio de trabajo, la respuesta es Invalid WhatsApp Client ID.

Si se filtra una API key#

Cualquier persona que tenga tu API key y tu API Client ID puede enviar mensajes desde tus números de WhatsApp y consumir los mensajes de tu espacio de trabajo.

Crea una clave de reemplazo
En Configuración → Claves API, haz clic en Crear Nuevo y copia la nueva clave.
Actualiza tus apps
Reemplaza la clave antigua en todas las apps e integraciones que la usaban.
Elimina la clave filtrada
Haz clic en Eliminar en la clave filtrada. Deja de funcionar de inmediato.
Busca usos indebidos
Revisa los mensajes recientes en Reportes por si hay algo que no enviaste tú.

Trata también como secreto el email "WbizTool Alert - WhatsApp Connected Successfully!": se envía al creador del espacio de trabajo cuando un número se conecta por primera vez y puede incluir una de tus API keys.

Solución de problemas#

Problema	Qué revisar
La pestaña Claves API muestra No Se Encontraron Claves API, pero existen claves	No eres Administrador en este espacio de trabajo, o hay otro espacio de trabajo seleccionado.
"You don't have permission to create API keys in this space." (no tienes permiso para crear API keys en este espacio)	Solo los Administradores pueden crear o eliminar claves. El botón Generar Nueva Clave API de una tabla vacía aparece para todos, pero solo funciona para los Administradores.
"You have reached the maximum limit of 10 API keys per organization."	Elimina una clave que ya no uses.
`Auth Error: invalid api key`	La clave se eliminó o se escribió mal, o el `client_id` no pertenece al mismo espacio de trabajo que la clave. Si una clave nueva y el ID de Cliente API que aparece en la página siguen fallando, contacta con soporte (los espacios de trabajo más antiguos pueden mostrar un ID de Cliente API que solo funciona con claves creadas por quien creó el espacio de trabajo).
`Auth Error - Please send correct API key and Client id`	Falta `api_key` en la solicitud.
`Invalid client id.` (o `Invalid Client Id` en algunos endpoints)	Falta el `client_id` o no es un número. En Comprobar credenciales, si falta `client_id` o `api_key` solo se devuelve `Auth Error`; ahí `Invalid Client Id` significa que no es un número. Cópialo de la tarjeta Resumen de API.
Las solicitudes actúan sobre el espacio de trabajo equivocado	La clave se creó en otro espacio de trabajo. Cambia de espacio de trabajo y crea una clave allí.
`Demo Account can not access apis`	Las cuentas de demostración no pueden usar la API. Regístrate para obtener una cuenta gratuita.