Generación y Uso de Clave API

Esta sección está destinada a los desarrolladores y administradores de centros que deseen interactuar con la API de Amadeus Magister. Aquí aprenderás cómo generar y utilizar una clave API para autenticar tus solicitudes.

¿Qué es una clave API?

Una clave API es un código único que permite autenticar y autorizar el acceso a una API (Interfaz de Programación de Aplicaciones). En el contexto de Amadeus Magister, las claves API son utilizadas para acceder a los endpoints y realizar operaciones en nombre del centro educativo.

Autenticación mediante clave API

Para poder interactuar con los endpoints protegidos de la API es necesario disponer de una clave API válida (no expirada y activa).

La clave sirve para identificar y autenticar los sistemas externos que deseen enviar solicitudes o consultar información. Toda petición a la API será registrada y asociada a la IP desde la cual se realice la llamada.

¿Cómo obtener una clave API?

Actualmente, las claves API son gestionadas por el administrador del centro, en caso de ser un desarrollador externo deberas solicitarla al centro. Para generar una clave API, deberás ir a:
Configuración del Centro 🡢 Otros 🡢 Clave API 🡢 Crear

A la hora de crear tu clave API, deberás proporcionar un nombre descriptivo para identificarla fácilmente. Este nombre será visible en la lista de claves API generadas y te ayudará a recordar su propósito. Así mismo, si lo deseas, puedes establecer una fecha de caducidad para la clave, lo que te permitirá gestionar su validez y seguridad de manera más efectiva.

Una vez generada, podrás ver:

El token de la clave API (string largo seguro).
El nombre asociado.
Y fechas como: creación, último uso y caducidad.

Importante: Te recomendamos manejar la clave API con máxima precaución. La clave otorga acceso completo a la API, por lo que debe ser compartida únicamente con personas o sistemas de absoluta confianza.

¿Cómo utilizar la clave API?

Para autenticar tus solicitudes correctamente, debes incluir la clave API en el encabezado Authorization de todas tus solicitudes utilizando el siguiente esquema:

Authorization: Bearer <API_KEY>

La palabra Bearer debe ir seguida de un espacio y luego la clave, sin comillas ni caracteres adicionales.

Consideraciones de Seguridad

No compartas tu clave públicamente ni la expongas en aplicaciones cliente (frontends).
Revoca y regenera una clave inmediatamente si sospechas que ha podido ser comprometida.
Mantén un registro de las claves API generadas y su uso para facilitar la gestión de seguridad.
Asegúrate de que las claves API no se almacenen en el código fuente ni en repositorios públicos.

GETapi/v1/test-key

Testear Clave API

Este endpoint permite validar que una clave API enviada es correcta y activa.

Request

GET

api/v1/test-key

curl https://dominio.amadeusmagister.com/api/v1/test-key \
  --header 'Authorization: Bearer <API_KEY>'

Response

{
  "status": "success",
  "data": {
      "id": 4,
      "name": "API Key de Prueba",
      "issued_at": "2025-04-28 12:33:00"
  }
}