Un Clave API autentifica tus solicitudes a la API de Simbase. Cada clave incluye un conjunto de permisos que se seleccionan al crearla, y dichos permisos son fijos a partir de ese momento. Una misma clave puede utilizarse para varias integraciones, pero lo más seguro es utilizar una clave por integración. Las claves se crean y gestionan en el panel de control, en Integraciones → API.

Crear una clave de API

1. Inicia sesión en dashboard.simbase.com.

2. Ve a Integraciones → API.

3. Haz clic en «Crear nueva clave API».

4. Ponle a la clave un nombre que indique para qué sirve, por ejemplo: Kit de herramientas Usage Guard. El nombre es solo una etiqueta. Aparece en tu lista de claves y en ningún otro sitio.

5. En la sección «Recursos», configura los permisos que necesita la clave. Consulta Permisos a continuación.

6. Haz clic en «Crear clave API» y, a continuación, copia la clave.

Echa un vistazo a la demostración que aparece a continuación para ver las instrucciones paso a paso:

Permisos

Los permisos se configuran por recurso, en uno de los tres niveles. Ninguno significa que la clave no puede coincidir en absoluto con ese recurso, y es el valor predeterminado en todas las filas. Leer Recupera datos y no modifica nada. Escribir crea, actualiza y elimina; al seleccionarla, también se selecciona «Lectura» en la misma fila, ya que cualquier operación de escritura requiere una lectura previa.

No todos los recursos ofrecen estas tres opciones. «Cuenta» y «Uso» son de solo lectura, por lo que muestran «Ninguno» y «Lectura». El «Estado de la tarjeta SIM», «Restablecimiento», «Registro» y «Desactivación automática» son acciones, no datos, por lo que muestran «Ninguno» y «Escritura».

El árbol de recursos

Filas principales y secundarias

Las secciones «Tarjetas SIM», «Utilidades» e «Integraciones» tienen una flecha junto al nombre. Haz clic en ella para desplegar los permisos individuales que aparecen debajo.

• Al configurar un elemento principal, todos los elementos secundarios se configuran al mismo nivel o al nivel más alto que ofrezca cada uno de ellos. Si se establece «Escribir» para todos los recursos, se asignan los permisos «Lectura» a «Cuenta» y «Uso», ya que «Lectura» es el nivel más alto que admiten.

• Al establecer un elemento hijo por sí solo, el elemento padre no muestra nada seleccionado. Esto es lo esperado. Un elemento padre solo muestra un nivel cuando todos sus elementos hijos coinciden.

Elegir un nivel

Proporciona lo mínimo necesario para el funcionamiento del sistema. Una clave que solo permite consultar el uso no puede desactivar una tarjeta SIM en caso de fuga de información.

En la referencia de la API, estos aparecen como nombres de ámbito creados a partir del mismo árbol. Los datos de la tarjeta SIM se corresponden con simcards.details:read y simcards.details:write.

Configuración avanzada

Activa la opción «Mostrar ajustes avanzados» para acceder a dos campos opcionales. Ambos pueden dejarse en blanco.

Restricciones de IP

Limita la clave a una única dirección IP de confianza o a un rango en notación CIDR. Se rechazan las solicitudes procedentes de cualquier otra dirección. Deja el campo en blanco si no deseas aplicar ninguna restricción. La lista de claves mostrará entonces 0.0.0.0/0 en «Direcciones IP permitidas», lo que significa cualquier dirección.

Caduca en (número de días)

El número de días desde su creación hasta que la llave deja de funcionar. Introduce 31 y la clave caducará dentro de 31 días. Si dejas el campo en blanco, la clave no caducará nunca.

Merece la pena utilizar claves de corta duración para migraciones puntuales, el acceso de contratistas y cualquier otra situación en la que, de otro modo, tendrías que acordarte de revocarlas.

Gestiona tus claves

La lista de API muestra todas las claves de la cuenta: su nombre, un identificador de clave truncado, el nivel de permiso con el que se creó, cuándo se utilizó por última vez y su restricción de IP. La última llamada a la API se muestra en tu zona horaria de la cuenta, y «Direcciones IP permitidas» muestra 0.0.0.0/0 donde no hay ninguna restricción.

El ID de clave solo sirve para distinguir unas claves de otras. Se trunca y no se puede utilizar para autenticarse.

Los permisos se establecen al crear la clave y no se pueden modificar posteriormente. Para cambiar las funciones de una clave, crea una nueva clave con los permisos que desees, cambia la integración y, a continuación, elimina la antigua.

El menú de tres puntos que aparece al final de cada fila tiene una única opción: Eliminar. Una clave eliminada deja de funcionar inmediatamente, y las solicitudes que la utilicen no superarán la autenticación.

Cómo utilizar la tecla

Envía la clave como token al portador en cada solicitud:

Solicitud

GET /v2/simcards HTTP/1.1
Host: api.simbase.com
Authorization: Bearer YOUR_API_KEY

La documentación completa sobre los puntos finales se encuentra en developer.simbase.com.

Preguntas frecuentes

Relacionado

• Webhooks — Recibe notificaciones de eventos en una URL de tu elección, sin necesidad de consultar la API

• Kit de herramientas Usage Guard (hazlo tú mismo) — una automatización ya preparada que utiliza una clave de API con permiso de escritura

• Protección contra robos — el simcards.details:write ámbito de aplicación en la práctica

• Zona horaria de la cuenta — establece la zona horaria en la que se muestra la columna «Última llamada a la API»