Endpoints Generales

A continuación se detallan los endpoints generales de la API de Amadeus Magister para la consulta de información básica. Estos endpoints son útiles para obtener datos como los términos y condiciones, lista de países, regiones, tipos de documentos y más.

GETapi/v1/general/terms

Obtener Términos y Condiciones

Este endpoint devuelve la URL de los términos y condiciones de uso de la aplicación Amadeus Magister que deben ser aceptados por el usuario en el proceso de inscripción.

Request

GET

api/v1/general/terms

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

Response

200 OK

{
  "status": "success",
  "data": "https://amadeusmagister.com/terminos-condiciones-app"
}

GETapi/v1/general/countries

Listar Países

Este endpoint devuelve una lista de países disponibles en el sistema, usando el estándar ISO 3166-1 alpha-2 (ejemplo: es para España, fr para Francia).
Nota importante: La lista de países es obligatoria para completar ciertos procesos, como la inscripción de alumnos o la configuración de perfiles de usuario.
Si el pais deseado no se encuentra disponible, se recomienda contactar con el soporte técnico de Amadeus Magister.

Request

GET

api/v1/general/countries

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

Response

200 OK

{
  "status": "success",
  "data": [
      "es",
      "fr",
      "de",
      "pt"
  ]
}

GETapi/v1/general/regions

Listar Regiones de un País

Este endpoint devuelve las regiones de un país específico.
Si la región deseada no se encuentra disponible, se recomienda contactar con el soporte técnico de Amadeus Magister.

Parámetros requeridos

Name
country_code
Type
string
Description
Código del país en el estándar ISO 3166-1 alpha-2, por ejemplo, es para España, según este endpoint.

Request

GET

api/v1/general/regions

curl https://dominio.amadeusmagister.com/api/v1/general/regions \
  --header 'Authorization: Bearer <API_KEY>' \
  --data '{
    "country_code": "es"
  }'

Response

200 OK

{
  "status": "success",
  "data": [
    {
      "key": "ab",
      "value": "Albacete"
    },
    {
      "key": "al",
      "value": "Alicante"
    },
    {
      "key": "alh",
      "value": "Almería"
    },
    ...
  ]
}

GETapi/v1/general/document_types

Tipos de Documento

Este endpoint devuelve los tipos de documentos válidos para la inscripción (DNI, Pasaporte, etc).

Request

GET

api/v1/general/document_types

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

Response

200 OK

{
  "status": "success",
  "data": [
    "dni",
    "nie",
    "passport",
    "nif"
  ]
}