Crear una clave de API

Una clave de API es la credencial de un sistema, no de una persona: tu ERP, tu tienda web o tu sistema de facturación la usan para cobrar y consultar a través del Merchant.

¿Vas a instalar un equipo?

Para una caja, un PC o un terminal Android no uses una clave: usa Enrolar un equipo. El equipo recibe su propia credencial, sin que nadie la vea.

Antes de empezar

• Necesitas el permiso de Claves API (rol Gerente o Desarrollador), y tu comercio debe tener la capacidad Desarrollador.
• Ten a mano a la persona que va a guardar la clave en el sistema que la usará.

Los pasos

1. En el menú del portal, abre Claves API y pulsa Crear clave.
2. En Etiqueta, escribe para qué es (por ejemplo, «ERP · cobros»). Sirve para reconocerla después; no es secreta.
3. Elige el alcance. Para un ERP o una tienda web, Integración. Usa Completo solo si de verdad lo necesitas.
4. Elige la caducidad: 30, 90 o 365 días, o sin caducidad. Una clave que vence obliga a rotarla, y eso es bueno.
5. Pulsa Crear.
6. Copia la clave en ese momento y guárdala en el sistema que la va a usar. Se muestra una sola vez: el portal no puede volver a enseñártela.

1234

Crear una clave con alcance de integración. Datos ficticios de ejemplo.

1. 1Una etiqueta para reconocerla
2. 2El alcance: qué puede hacer
3. 3Cuándo vence
4. 4Crear

✕

Cómo se usa

El sistema envía la clave en la cabecera X-API-Key de cada llamada a la API del Merchant, siempre desde un servidor. Nunca la pongas en el código de una página web, en una aplicación móvil ni en un equipo del mostrador: cualquiera podría leerla.

Si una clave se filtra

Pulsa Revocar junto a ella en la lista, de inmediato, y crea otra. Revocar funciona siempre, aunque tu comercio haya perdido la capacidad de crear claves nuevas. Una clave vencida queda en la lista, atenuada, como «Vencida».

Para entender los alcances, lee Roles y permisos del comercio.