Acceso a la API (para desarrolladores)

Configuración → Integraciones (/app/settings/integrations), tarjeta Acceso a la API (para desarrolladores), al final de la página. Solo propietarios y administradores. "Conecta OmniBrand con tus propios sistemas, Zapier o Make para crear publicaciones, añadir contactos o leer analíticas automáticamente." Una clave permite que tu propio software llame a la API pública de OmniBrand con la cabecera Authorization: Bearer ob_live_… La parte inferior de la tarjeta, Endpoint de la API, muestra la dirección a la que enviar esas solicitudes ("La dirección a la que responde la API pública. Envía cada solicitud allí, con una de las claves anteriores."). Los enlaces antiguos a /app/settings#developer abren esta tarjeta.

Qué planes lo incluyen

El acceso a la API forma parte de los planes Agencia y Enterprise. En Gratis, Starter y Pro, y durante la prueba de Pro de 14 días, la tarjeta solo muestra "El acceso a la API está disponible en el plan Agencia." con un enlace Ver planes a Plan y uso; no hay formulario de claves. Las tarjetas de planes de Plan y uso y de /pricing indican Acceso a la API para Agencia y Enterprise.

Cuando cambia el plan

• Cuando la cuenta pasa a un plan sin acceso a la API (una bajada de plan, un reembolso o el fin de una prueba), sus claves quedan en pausa: se conservan y no se borra nada, pero cada llamada hecha con ellas se rechaza con "API access is available on the Agency and Enterprise plans. Upgrade under Settings > Plan & usage to use API keys." (HTTP 403, código api_access_not_in_plan).
• El propietario de la cuenta recibe un único correo, Your API keys are paused ("Tus claves de API están en pausa porque tu plan ya no incluye acceso a la API…"), con un botón Ver planes.
• Volver a Agencia o Enterprise reactiva las mismas claves en menos de un minuto. No hace falta crear claves nuevas.
• Mientras están en pausa, las claves no se muestran y no se pueden crear ni rotar. Para detener una clave para siempre, vuelve a un plan con acceso a la API y haz clic en Revocar, o escribe a soporte.

Paso a paso: crea una clave

1. Escribe un nombre en Nombre de la clave (por ejemplo, CI bot), hasta 60 caracteres, para saber más adelante qué lo utiliza. Sin nombre (o solo espacios), Crear clave no crea nada y la caja dice "Dale un nombre a la clave, por ejemplo "Website sync"." Se eliminan los espacios antes y después del nombre.
2. En Ámbitos de la clave, elige solo lectura (datos de lectura) o lectura + escritura (también creando y cambiando cosas).
3. Haz clic en Crear clave.
4. Una caja amarilla muestra "Nueva clave para "(nombre)". Cópiala ahora: solo se muestra una vez." y la clave completa, con Copiar (luego dice Copiado) y Lo he guardado, que cierra la caja. Copia la clave ahora y guárdala en un lugar seguro; OmniBrand solo almacena una huella digital y nunca podrá mostrarla de nuevo.

La lista

Cada tecla muestra su nombre, los primeros caracteres (ob_live_...), su alcance, cuándo se usó por última vez ("usó ..." o "nunca se usó") y "expira ..." con su fecha de finalización.

• Rotar: pregunta primero: "¿Rotar "(nombre)" (prefijo…)? Recibes una nueva clave de inmediato. La clave actual sigue funcionando durante 24 horas y luego deja de funcionar, así que pon la nueva clave en todos los sitios donde se use la antigua antes de que pase ese plazo." Haz clic en Rotar la clave para continuar, o en Cancelar. La nueva clave, con el mismo nombre y alcance, se muestra una sola vez en el mismo recuadro amarillo. La clave antigua sigue funcionando 24 horas para que puedas cambiar tu integración, y después deja de funcionar. Hasta entonces sigue en la lista, sin tachar, con "La clave anterior funciona hasta [fecha y hora]" y un botón Revocar.
• Revocar: pregunta "¿Revocar la clave (nombre) (prefijo…)? Todo lo que la use deja de funcionar al instante, y una clave revocada no se puede volver a activar." La ventana se titula ¿Revocar la clave?; haz clic en Revocar clave para detener la clave al instante, o en Cancelar para conservarla. Esto también funciona con una clave antigua durante sus 24 horas posteriores a una rotación: si la rotaste porque se filtró, haz clic en Revocar en la clave antigua para que se detenga ya. Las claves revocadas (y las rotadas una vez pasadas sus 24 horas) siguen en la lista, tachadas, con una etiqueta roja "Revocada el (fecha)" bajo el nombre.

¿Quién posee una llave?

• Una clave pertenece a la persona que la creó y cubre los espacios de trabajo donde esa persona es propietario o administrador en el momento de la creación.
• Funciona solo mientras su creador sigue siendo propietario o administrador activo de todos los espacios de trabajo que cubre. Si son eliminados, degradados o su inicio de sesión deshabilitado, las llamadas fallan con "La persona que creó esta clave API ya no administra sus espacios de trabajo. Pide a un administrador actual que emita una nueva clave."
• Verás, rota y revoca solo las claves cuyos espacios de trabajo administras tú mismo. En una cuenta con muchos espacios de trabajo de cliente, el administrador de un cliente no puede ver las claves de otro cliente.

Si algo sale mal

• "This API key has expired. Rotate it under Settings > Integrations > API access.": las claves duran un año. Haz clic en Rotar en la clave dentro de Acceso a la API (para desarrolladores) (o crea una nueva) y actualiza tu integración.
• "Clave API inválida o revocada": la clave fue revocada, su gracia de rotación de 24 horas terminada o copiada incompletamente.
• Una clave API no puede crear, rotar ni revocar otras claves; solo una persona con inicio de sesión puede hacerlo.
• "Este endpoint no está disponible para claves API": esa llamada es solo para una persona con la sesión iniciada, sea cual sea el alcance de la clave. Una clave nunca puede acceder a: miembros e invitaciones (/workspaces/{id}/members, /workspaces/{id}/invitations, /invitations), crear, renombrar, archivar, desarchivar o eliminar un espacio de trabajo, webhooks salientes (/workspaces/{id}/webhooks), exportaciones, la cadena de aprobación, la programación de informes, conectar, desconectar o eliminar un canal o cambiar su propietario, el logotipo, el perfil y la configuración inicial de la organización, y cualquier cosa bajo /auth, /billing, /admin o /tenant/api-keys. Hazlo en la app, con la sesión iniciada como propietario o administrador. La IA con una clave cubre texto de publicaciones, ideas, imágenes, reescrituras, hashtags, texto alternativo y clasificación de mensajes, hasta 10 llamadas por minuto y 300 al día por clave ("API key AI rate limit exceeded"); el vídeo, AI Studio y los demás asistentes de IA son solo para personas con sesión iniciada. Las tareas, fuentes y ajustes de Market Watch, los bots y los ajustes del espacio de trabajo como la clasificación automática también solo los puede cambiar una persona con sesión iniciada. Activar o desactivar el soporte, cambiar su clasificación con IA y la lectura con IA de Brand Health también requieren una persona con sesión iniciada, y un informe pedido con una clave incluye un resumen de IA solo si ya existe.

Relacionado

• Planes
• Integraciones: webhooks salientes
• Roles y permisos
• La página de Configuración