Protocolos

Actualizado

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

¡Próximamente!

Para simplificar las interacciones tanto como sea posible, la API permite que ciertas interacciones mantengan la conexión hasta que haya una respuesta disponible o se alcance un tiempo de espera. Por el momento, esto solo es posible en la creación de sesiones.

Para habilitar esta función, agregue el Ricloud-Await HTTP Ricloud-Await a su solicitud con el valor de tiempo de espera (máximo actual de 30 segundos). Por ejemplo:

Ricloud-Await: 10

Publicación encriptada

¡Próximamente!

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

Tipos de atributos

Cualquier atributo de fecha y hora siempre se formateará de acuerdo con la especificación ISO8601. La API devuelve todos los atributos de fecha y hora con la zona horaria UTC. Por lo tanto, el formato esperado es "2018-08-22T10:25:05Z" .

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.

¿Cómo podemos ayudar?

¡Nuestro equipo de soporte está aquí para ayudar!

Nuestro horario de atención es de lunes a viernes de 9 a.m. a 5 p.m. GMT. El tiempo es actualmente 11:07 AM GMT.

Intentamos responder todos los mensajes en un plazo de un día laboral.

Ir a la sección de soporte › Póngase en contacto con el equipo de la empresa. ›
Nuestro increíble equipo de soporte.

© 2008 - 2019 Reincubate Ltd. Todos los derechos reservados. Registrado en Inglaterra y Gales #5189175, VAT GB151788978. Reincubate® es una marca registrada. Términos y privacidad. Recomendamos la autenticación de múltiples factores. Construido con en Londres.