A la hora de solicitar o enviar datos al API es necesario indicar algunas cabeceras en la petición HTTP:

• Api-Token Valor de la clave (token de autenticación) que se haya configurado en Ágora desde la pantalla de Activar Módulos Adicionales.

  Api-Token: gtSUwbHbxwg3hRXhZ01Kictq

• Accept Formato de serialización empleado. Por defecto se usará JSON si está cabecera no está presente. Los valores soportados son:

  Accept: application/xml para XML 

  Accept: application/json para JSON

• Accept-Encoding (opcional) Permite habilitar la compresión de datos en la respuesta para reducir el tráfico de red a costa de incrementar el tiempo de proceso en el servidor. Para habilitar la compresión es necesario añadir esta cabecera con el valor:

  Accept-Encoding: gzip

• Content-Type Formato del contenido enviado en las peticiones POST. Es necesario indicar el encoding para evitar problemas con caracateres no ASCII. Los formatos más habituales son:

  Content-Type: application/xml; charset=utf-8 para XML.

  Content-Type: application/json; charset=utf-8 para JSON

El código de estado de la respuesta será 200 OK en caso de que la petición se ha procesado con éxito, o un código de error en caso contrario. Si se trata de una solicitud de exportación de datos, el cuerpo de la respuesta contendrá los datos exportados en el formato indicado. Además, se incluiría una cabecerá Api-Version con la versión de Ágora que ha generado la respuesta para permitir que los sistemas externos puedan amoldarse a cambios de versiones.