Protocolos

Procesamiento asíncrono

La API utiliza el procesamiento asíncrono para todas las encuestas. Esto incluye interacciones con servicios externos, como iCloud, ya que pueden tardar segundos o minutos en completarse, dependiendo de la cantidad de procesamiento requerido.

Una serie de interacciones de recursos estándar pueden desencadenar "efectos secundarios" asincrónicos que se describen en la documentación de referencia de la API. Estos son típicamente para realizar verificaciones de validez u otras funciones de utilidad.

La base asíncrona de la API también ayuda a simplificar la interfaz para el sondeo periódico que se desencadena desde la API. Esto significa que la recuperación de eventos y resultados es la misma, ya sea interactuando con la API directamente o mediante encuestas programadas.

Espera respuesta

La API admite la espera de la finalización de tareas asincrónicas a través de solicitudes de larga duración para minimizar la necesidad de sondeo y reducir el tiempo de respuesta total para los usuarios finales. Para habilitar esta funcionalidad, agregue el encabezado HTTP Ricloud-Await a sus solicitudes con el valor de tiempo de espera deseado. El valor de tiempo de espera máximo actual es de 10 segundos.

Ricloud-Await: 3

Esta funcionalidad es compatible con los siguientes puntos finales:

• Crear sesión POST /sessions
• Probar la configuración de almacenamiento POST /configs/storage/{storage_config ID}/test
• Pruebe la configuración POST /configs/webhook/{webhook_config ID}/test

Publicación encriptada

Todos los resultados publicados por la API se pueden cifrar mediante una clave RSA pública de toda la organización.

Pruebas de usuario final

Un módulo de prueba de usuario final está disponible para uso del cliente. Esto se puede utilizar para devolver un "adelanto" de datos a posibles usuarios finales. El módulo proporciona una fuente de los últimos cinco mensajes junto con una última ubicación y un recuento resumido de otros mensajes disponibles.

Usar este mecanismo puede ser más rentable que usar una clave completa para las pruebas de usuario final.

Análisis e informes

El servicio iCloud de ricloud proporciona una serie de características adicionales en torno a análisis e informes.

Hay dos módulos disponibles para las empresas: el uso básico de la aplicación, que muestra qué aplicaciones se usaron en un dispositivo iOS en un día determinado, y el uso avanzado de la aplicación, que proporciona información adicional que incluye el número de sesiones, la duración de las sesiones, etc. Más información sobre estos módulos está disponible a petición.

Forense y recuperación

La funcionalidad de recuperación y recuperación forense está disponible para varios módulos como se indica a continuación, incluidos los módulos Mensajes (SMS, MMS e iMessage) y Biblioteca de fotos de iCloud.

Reincubar tiene una serie de herramientas forenses personalizadas que se pueden aplicar a otros módulos, como WhatsApp y WeChat.

Tipos de atributos

Fecha y hora

Los atributos de fecha y hora se formatean de acuerdo con la especificación ISO8601. La API devuelve todos los atributos de fecha y hora con la zona horaria UTC, es decir, "2018-08-22T10:25:05Z" .

Varios puntos finales de la lista de recursos permiten filtrar los atributos de fecha y hora, como date_created . Para filtrar utilizando operadores más útiles, prefija el valor del filtro de fecha y hora con uno de lt_ , lte_ , gt_ o gte_ .

Timedelta

Los atributos del tipo timedelta siempre están en segundos a menos que se especifique lo contrario.

Paginación

La API hace uso de la paginación basada en el cursor. Todas las llamadas de tipo de lista toman los parámetros adicionales:

• limit para especificar el número máximo de artículos a devolver. El valor predeterminado es 10, valor máximo 1000.
• after_id para especificar la ID a partir de la cual comenzar a listar.
• before_id para especificar el ID de recurso desde el cual dejar de listar.

Las respuestas de la lista incluyen recursos devueltos bajo el atributo de data . También se incluye el atributo de ayuda has_more que señala si se pueden enumerar más recursos que no se incluyeron debido al límite.

Limites de tarifa

Las solicitudes a la API pueden estar limitadas ya sea por un límite de tasa estándar o por un límite de solicitudes en vuelo. El primero se usa para minimizar el abuso de los recursos API a escala, mientras que el último se usa para proteger instancias de recursos individuales.

Ejemplo de límite de velocidad: el número de solicitudes a la API de una sola organización está limitado a 10.000 solicitudes por hora. Esto ayuda a proteger contra picos maliciosos o accidentales en el tráfico.

Ejemplo de límite de vuelo : una instancia de un recurso de origen no puede tener una tarea creada contra ella si otra tarea ya se está procesando. Esto mantiene la integridad de la sesión, minimiza el tráfico a los servicios externos y

Versiones

Aunque las principales versiones de la API siguen un esquema de versión semántica en gran medida (es decir, v1 , v2 , v3 ), cualquier cambio realizado dentro de la versión v3 de la API se versiona siguiendo un esquema de versión del calendario (es decir, 2018-11-06 ). La versión puede configurarse globalmente para su organización o especificarse por solicitud a través del Ricloud-Version .

Recursos deltables

La mayoría de los recursos no se pueden eliminar, lo que significa que solo pueden ser desactivados por la organización propietaria o bloqueados por un administrador de API.