Ir al contenido principal

Acceso a la API

Escrito por Yoanna Hristova

El acceso a la API permite que una organización conecte sus propias herramientas y flujos de trabajo con Grabyo. Una vez activado, los usuarios autorizados pueden crear y gestionar sus propias claves de API (API keys) directamente desde los ajustes de la organización, sin que Grabyo tenga que crearlas manualmente.

Cómo activar el acceso a la API

El acceso a la API se activa para cada organización. Si tu organización quiere usar la API, contacta primero con tu gestor de cuenta (account manager). Una vez aprobado el acceso, Grabyo te envía la documentación de la API y activa la sección API en los ajustes de tu organización.

Antes de empezar

  1. Solicita el acceso a la API a través de tu gestor de cuenta.

  2. Confirma que tu organización ha firmado los términos del servicio de la API.

  3. Espera la confirmación de que la sección API está activada en los ajustes de tu organización.

Cómo crear una clave de API

Las claves de API se crean y gestionan en el área de ajustes de la organización, una vez activado el acceso a la API.

  1. Abre los ajustes de tu organización y ve a la sección API.

  2. Selecciona CREATE API KEY.

  3. Se crea al momento una nueva clave de API con los ajustes predeterminados, que aparece en la tabla.

  4. Abre el menú de opciones de la clave para revisar o actualizar su configuración.

📕 Nota: al seleccionar CREATE API KEY no se abre ningún menú de configuración ni se muestran opciones antes. La clave se crea directamente con los ajustes predeterminados.

✅ Consejo: el botón API DOCUMENTATION, situado al lado, abre la documentación de la API de Grabyo.

Cómo gestionar una clave de API

Una vez creada la clave, gestiónala desde la sección API de la página de la organización. Selecciona el menú de opciones al final de la fila de la clave para ver las acciones disponibles.

Acción

Para qué sirve

Edit

Cambiar los ajustes de la clave y darle acceso a Streams y Campaigns.

Rotate key

Rotar la clave.

Suspend key

Suspender la clave.

Delete key

Eliminar la clave.

Editar una clave de API

Al seleccionar Edit se abre la ventana Edit API key, donde se definen el nombre (Name), el rol (Role) y el acceso de la clave. Si te desplazas hacia abajo en la misma ventana, encontrarás más ajustes.

📕 Nota: la ventana de edición es la ventana estándar de usuario de Grabyo que se usa en otras partes de la plataforma. Es normal, porque Grabyo trata las claves de API como un tipo de usuario.

Acceso a Streams y Campaigns

Crear una clave de API no da acceso automáticamente a Streams ni a Campañas (Campaigns). El acceso se añade para cada clave en el área API key access de la ventana de edición.

  1. Abre el menú de opciones de la clave y selecciona Edit.

  2. En Stream access, mueve los streams que necesita la clave desde la lista de excluidos, a la izquierda, a la lista de incluidos, a la derecha. Escribe en el cuadro de filtro para encontrar un stream rápidamente.

  3. En Campaign access, haz lo mismo con las campañas.

  4. Selecciona APPLY para guardar.

📕 Nota: un usuario ADMIN tiene que añadir de forma específica el acceso a Streams y Campaigns para cada clave de API. Hasta entonces, la clave no puede usar esos recursos.

Buenas prácticas

Área

Recomendación

Creación de claves

Crea claves de API solo para casos de integración aprobados.

Ajustes de las claves

Revisa los ajustes después de crear la clave, ya que las claves nuevas se crean con los ajustes predeterminados.

Streams Campañas

Da acceso solo a los recursos que la integración necesita de verdad.

Administración

Limita los cambios administrativos a los usuarios autorizados.

Implementación

Usa la documentación de la API como referencia principal para los detalles de implementación.

¿Ha quedado contestada tu pregunta?