En esta página:

API de eventos del campus

La API de Campus Events permite a los desarrolladores incorporar datos y funciones de Campus Events directamente en sus propias aplicaciones o sitios web. De este modo, se pueden integrar fácilmente, por ejemplo, los detalles de los eventos o las listas de participantes.

Nuestra API se basa en la tecnología REST.

Entre las ventajas de REST se encuentran:

  • Alto rendimiento: rápido procesamiento de las solicitudes.
  • Escalabilidad: muy adecuada para procesar muchas solicitudes al mismo tiempo.
  • Interfaces sencillas: fáciles de entender y de implementar.

La documentación está disponible en https://IHREDOMAIN.com/api. En Sistema > Messenger > Webhooks se pueden registrar sistemas externos. Cuando se definen eventos, se envía a estos un mensaje correspondiente como «solicitud POST».

¿Qué es REST? ​

REST es un estándar ampliamente utilizado para el intercambio de datos a través de Internet. Se basa en los principios de HTTP (como en las páginas web). Un cliente (por ejemplo, su aplicación) envía una solicitud al servidor (por ejemplo, Campus Events) y el servidor devuelve una respuesta con los datos solicitados.

¿Cómo se obtiene una clave API? ​

Una clave API permite acceder a la API. Para obtener dicha clave, debe

  1. Haber iniciado sesión en Campus Events.
  2. Estar asignado al grupo de usuarios "API Key Hero" (este grupo de usuarios está autorizado a crear y gestionar claves API).

Puede encontrar las claves API en: Configuración > Claves API. Allí puede utilizar el botón "+ Nuevo" para crear una nueva clave o gestionar los registros de datos existentes.

Grupos de datos ​

Los grupos de datos adicionales pueden utilizarse para consultar información adicional, a veces confidencial, como datos personales, detalles de facturas o historiales de pedidos que normalmente no son visibles.

Una visión general actualizada de todos los grupos de datos:

  • Datos personales del usuario
  • datos personales de los participantes
  • eventos no publicados
  • datos de facturación
  • datos personales de pedidos
  • información del pedido
  • información de pago adicional

Puntos de conexión de la API ​

En Campus Events existen funciones de la API para crear, modificar y eliminar registros. Los permisos para crear/modificar y eliminar registros se pueden configurar individualmente para cada clave de API. Se dispone de las siguientes funciones

  • Eventos (incluidas fechas, categorías de entradas y precios, imágenes del evento, así como información y archivos para descargar)
  • Listas de eventos
  • Lugares de celebración
  • Categorías de eventos
  • Público objetivo
  • Categorías de entradas
  • Organizadores
  • Categorías de filtro
  • Patrocinadores (incluida la subida de logotipos)
  • Moderadores
  • Personas de contacto
  • Crear, modificar y eliminar participantes en el evento (entradas)
  • Creación, modificación y eliminación de restricciones y decisiones sobre entradas
  • Artículos adicionales: los importes de impuestos de cada artículo del pedido se indican directamente en el mismo

El punto final de la API «/events/{id}» devuelve los datos «dynamicAttributes» en orden clasificado (según el orden del backend). Todos los demás puntos finales devuelven «dynamicAttributes» (si están disponibles) en orden alfabético.

Atención

  • El orden de los puntos de datos no es determinista. No se excluye ni se comunica una modificación del mismo.
  • Los clientes son responsables de comprobar las notas de la versión para detectar posibles cambios en la API e informar a otros proveedores de servicios en caso necesario.

Plataforma Campus Events API ​

Puede acceder a la plataforma API a través deIhre-Campus-Events-Domain.de/api. Aquí puede:

  • Ver varios puntos finales (interfaces) de la API.
  • Explorar estructuras de datos.
  • Realizar solicitudes de prueba y obtener resultados.

Para ello se necesita un usuario administrador. Como alternativa, se puede añadir la clave de API a la URL, por ejemplo: https://Ihre-Campus-Events-Domain.de/api?apiKey=00000000-0000000000000000-00000000(en este punto, se ha introducido "0" como ejemplo en lugar de una clave de API correcta). Los demás pasos de autenticación deben seguir realizándose.

Haciendo clic en el botón "Autorizar", puede introducir su clave de API y definir la autorización para las solicitudes (por ejemplo, mediante encabezado o URL).

Recomendamos los métodos a través de "apiKeyHeader (apiKey)".

Solicitudes API ​

Una vez autorizada su clave API, puede empezar a realizar solicitudes, por ejemplo, para recuperar eventos o datos de participantes. Haga clic en "Probar" para generar una solicitud.

Por defecto, la respuesta se emite en formato JSON, fácil de leer y procesar con programas.

Ejemplo de consulta (Curl) 

curl -X 'GET \
  'https://[su dominio]/api/events?page=1' \
  -H 'accept: application/ld+json' \h 'x-api-key: xxxxxxxx-xxxxxxxxxxxxxx-xxx
  -H 'X-API-KEY: XXXXXXXX-XXXXXXXXXXXXXXXXXX-XXXXXXXXXXXXXX'

Solicitar URL 

https:// [su dominio] /api/events?page=1

Respuesta 

{
  "@context": "/api/contexts/Event",
  "@id": "/api/events",
  "@type": "hydra:Collection",
  "hydra:totalItems": 409,
  "hydra:member": [
    {
      "@id": "/api/events/2946",
      "@type": "Evento",
      "orderType": 4,
      "startDate": "2023-11-02T12:00:00+01:00",
      "endDate": "2023-11-03T16:30:00+01:00",
      "modifiedAt": "2023-11-03T16:30:07+01:00",
      "subtitle": "Simposio en el Centro Internacional de Estudios/Centro de Idiomas",
      "name": "Repensar la internacionalización",
      "modifiedAtRecursive": "2024-07-10T00:08:52+02:00",
      "@urls": {
        "directRegistrationUrl": null,
        "eventUrl": "https://[sudominio]/event/internationalisation" 
      }
    }
  ]
}

Opciones de filtrado ​

Encontrará todas las opciones de filtro actuales en la vista general de la API https://Dominio de eventos de su campus.de/api