Especificación de la API de Cytomic Orion

Todas las llamadas a la API de Cytomic Orion deben de incluir el token de acceso obtenido en Autenticación, autorización y obtención del token de acceso mediante la cabecera Authorization: Bearer {token}.

En este apartado se incluyen las diferentes llamadas a la API de Cytomic Orion, su sintaxis, significado de los parámetros y su formato, así como los resultados devueltos.

Cytomic Orion utiliza una interface REST para intercambiar información entre la plataforma y las aplicaciones de terceros: El protocolo para el transporte de mensajes entre ambos extremos es HTTPS y para encapsular los tipos de datos complejos utiliza el estándar JSON.

Esquema general de una llamada

En cada llamada a la API de Cytomic Orion, la aplicación de terceros necesitará especificar algunos o todos los parámetros mostrados a continuación:

  • Tipo de método HTTPS: comando HTTP utilizado en la petición:

    • GET: la llamada realiza una petición de información pasando los parámetros únicamente en la URL.

    • POST: la llamada realiza una petición de información pasando los parámetros en el cuerpo del mensaje HTTP y opcionalmente en la URL.

  • URL: ruta relativa al recurso. Como parte de la ruta se incluyen los parámetros indicados mediante llaves en la especificación. Los parámetros opcionales se indican mediante el formato “query string”.

  • Cuerpo: hace referencia a la zona del mensaje HTTP donde se incluyen los datos, localizada después de las cabeceras. Contiene los parámetros de tipos complejos en las llamadas POST.

  • Código de retorno HTTP: indica si la llamada tuvo éxito o terminó de forma errónea. Consulta Códigos de retorno para obtener un listado de los códigos devueltos por cada llamada a la API de Cytomic Orion.

Tipos de datos

La mayor parte de los parámetros son de tipo entero o cadena de caracteres. Estos parámetros pueden viajar en la llamada tanto en la ruta de la URL como en formato querystring. En la respuesta van incluidos en el cuerpo del mensaje.

Todos los parámetros de tipo fecha requieren el formato Unix Timestamp en milisegundos. Si el analista introduce una fecha en segundos, Cytomic Orion la convierte automáticamente al formato milisegundos.

Tanto en la llamada como en la respuesta, para los tipos de datos más complejos se utilizan listas de uno a “n” elementos de tipo JSONs en el cuerpo del mensaje HTTP.

Códigos de retorno

Los códigos de retorno son comunes a todas las llamadas y se indican en la cabecera status del mensaje HTTP, con el formato status: código:

Código Descripción

200

Operación completada con éxito.

400

Parámetro mal formado o ausente.

401

Fallo en el proceso de autenticación.

403

Fallo en el proceso de autorización.

Códigos de retorno