Saltar al contenido principal
La API de GetQR está en beta y solo está disponible para algunos espacios de trabajo. Los detalles pueden cambiar antes del lanzamiento general.
La API de GetQR autentica cada solicitud con la clave de API de tu cuenta. Cada usuario tiene una clave, que actúa en tu nombre en un espacio de trabajo.

​
Antes de empezar

  • Eres el propietario del espacio de trabajo o un editor. Los lectores no pueden crear ni usar una clave de API.
  • El propietario del espacio de trabajo tiene una suscripción activa.

​
Crea tu clave de API

1

Abre la configuración de tu cuenta

Abre la configuración de tu cuenta y ve a API.
2

Genera la clave

Haz clic en Generate API key.
3

Copia la clave

Muestra la clave y cópiala. Las claves empiezan por sk_live_.
Puedes volver a mostrar y copiar la clave en cualquier momento. La configuración también indica cuándo se creó la clave y cuándo se usó por última vez.

​
Autentica las solicitudes

Envía la clave como token Bearer en la cabecera Authorization de cada solicitud:
La comprobación de estado es el único endpoint que funciona sin clave.

​
Acceso y roles

  • Roles. Solo el propietario del espacio de trabajo y los editores pueden crear y usar una clave de API. Los lectores no pueden.
  • Espacio de trabajo. Cada clave pertenece a un único espacio de trabajo, y todas las solicitudes se ejecutan en él. No necesitas indicar el ID del espacio de trabajo.
  • Comprobación continua. El acceso se comprueba en cada solicitud según tu rol actual y la suscripción del propietario del espacio de trabajo. Tu propia suscripción no cuenta. Si tu rol pasa a lector o la suscripción del propietario finaliza, las solicitudes devuelven 403 hasta que se restablezca el acceso. No necesitas una clave nueva.
  • Eliminación. Si te quitan del espacio de trabajo, tu clave de API se elimina. Si vuelven a añadirte, genera una clave nueva.

​
Regenera tu clave

Regenera la clave si se filtra o si alguien que no debería tenerla obtiene acceso.
Tu clave actual deja de funcionar de inmediato. Cualquier app o integración que la use falla hasta que la actualices con la clave nueva.
1

Haz clic en Regenerate

En la configuración de tu cuenta, ve a API y haz clic en Regenerate.
2

Confirma

Haz clic en Regenerate key.
3

Actualiza tus apps

Copia la clave nueva y sustituye la antigua en todos los sitios donde la uses.

​
Protege tu clave

Trata la clave como una contraseña: cualquiera que la tenga puede crear, cambiar y eliminar códigos QR en tu espacio de trabajo.
  • Guárdala en una variable de entorno o en un gestor de secretos, no en el código fuente.
  • Llama a la API solo desde tu servidor. Nunca pongas la clave en un sitio web, una app móvil ni en nada que los usuarios puedan inspeccionar.
  • Compártela solo con los desarrolladores que la necesiten.
  • Regenérala en cuanto sospeches que se ha filtrado.

​
Problemas habituales

La clave se regeneró, o te quitaron del espacio de trabajo y la clave se eliminó. Copia la clave actual desde la configuración de tu cuenta o genera una nueva.
Comprueba que tu rol es propietario o editor y que la suscripción del propietario del espacio de trabajo está activa. La clave vuelve a funcionar en cuanto se restablece el acceso.
La API está en beta y todavía no está habilitada para tu espacio de trabajo.
Solo aparece para el propietario del espacio de trabajo y los editores, y solo en los espacios de trabajo que tienen la API habilitada.

​
Siguientes pasos

Introducción a la API

Errores