Protocolos

Processamento assíncrono

A API faz uso de processamento assíncrono para todas as pesquisas. Isso inclui interações com serviços externos, como o iCloud, pois podem levar segundos ou minutos para serem concluídos, dependendo da quantidade de processamento necessária.

Várias interações de recurso padrão podem acionar "efeitos colaterais" assíncronos, descritos na documentação de referência da API. Estes são tipicamente para realizar verificações de validade ou outras funções de utilidade.

A base assíncrona da API também ajuda a simplificar a interface para pesquisas periódicas que são acionadas na API. Isso significa que a recuperação de eventos e resultados é a mesma, seja interagindo com a API diretamente ou por meio de pesquisas agendadas.

Aguarde resposta

A API suporta aguardar a conclusão de tarefas assíncronas por meio de solicitações de longa duração para minimizar a necessidade de pesquisa e reduzir o tempo total de resposta dos usuários finais. Para ativar essa funcionalidade, inclua o cabeçalho HTTP Ricloud-Await em suas solicitações com o valor de tempo limite desejado. O valor atual de tempo limite máximo é de 10 segundos.

Ricloud-Await: 3

Essa funcionalidade é suportada nos seguintes pontos de extremidade:

• Criar sessão POST /sessions
• Testar a configuração de armazenamento POST /configs/storage/{storage_config ID}/test
• Teste a configuração do webhook POST /configs/webhook/{webhook_config ID}/test

Publicação Criptografada

Todos os resultados publicados pela API podem ser criptografados usando uma chave RSA pública para toda a organização.

Avaliações de usuário final

Um módulo de avaliação do usuário final está disponível para uso do cliente. Isso pode ser usado para retornar um "teaser" de dados a possíveis usuários finais. O módulo fornece um feed das últimas cinco mensagens, juntamente com um último local e uma contagem resumida de outras mensagens disponíveis.

O uso desse mecanismo pode ser mais econômico do que usar uma chave completa para testes do usuário final.

Análise e relatórios

O serviço iCloud do ricloud fornece vários recursos adicionais em torno de análises e relatórios.

Dois módulos estão disponíveis para empresas: uso básico do aplicativo, que mostra quais aplicativos foram usados em um dispositivo iOS em um determinado dia, e uso avançado do aplicativo, que fornece informações adicionais, incluindo número de sessões, duração das sessões e assim por diante. Mais informações sobre esses módulos estão disponíveis mediante solicitação.

Forense e recuperação

A funcionalidade forçada de recuperação e recuperação está disponível para vários módulos, conforme indicado abaixo, incluindo os módulos Mensagens (SMS, MMS e iMessage) e Biblioteca de Fotos do iCloud.

Reincubar tem um número de ferramentas forenses personalizadas que podem ser aplicadas a pedido de outros módulos, incluindo WhatsApp e WeChat.

Tipos de atributos

Data hora

Os atributos de data e hora são formatados de acordo com a especificação ISO8601. A API retorna todos os atributos de data e hora com o fuso horário UTC, ou seja, "2018-08-22T10:25:05Z" .

Vários pontos de extremidade da lista de recursos permitem a filtragem de atributos de data e hora, como date_created . Para filtrar usando operadores mais úteis, prefixe o valor do filtro datetime com um de lt_ , lte_ , gt_ ou gte_ .

Timedelta

Os atributos do tipo timedelta estão sempre em segundos, a menos que especificado de outra forma.

Paginação

A API faz uso da paginação baseada em cursor. Todas as chamadas do tipo de lista usam os parâmetros adicionais:

• limit para especificar o número máximo de itens a serem retornados. O valor padrão é 10, valor máximo 1000.
• after_id para especificar o ID do qual começar a listagem.
• before_id para especificar o ID do recurso a partir do qual parar a listagem.

As respostas da lista incluem recursos retornados sob o atributo de data . Também está incluído o atributo auxiliar has_more que sinaliza se mais recursos podem ser listados, os quais não foram incluídos devido ao limite.

Limites de taxa

As solicitações para a API podem ser limitadas por um limite de taxa padrão ou por um limite de solicitações em andamento. O primeiro é usado para minimizar o abuso de recursos da API em escala, enquanto o segundo é usado para proteger instâncias de recursos individuais.

Exemplo de limite de taxa: o número de solicitações para a API de uma única organização é limitado a 10.000 solicitações por hora. Isso ajuda a proteger contra picos maliciosos ou acidentais no tráfego.

Exemplo de limite em vôo : uma instância de um recurso de origem não pode ter uma tarefa criada nela se outra tarefa já estiver sendo processada. Isso mantém a integridade da sessão, minimiza o tráfego para serviços externos e

Versão

Embora os principais lançamentos da API sigam um esquema de versionamento semântico em grande parte (ou seja, v1 , v2 , v3 ), quaisquer alterações feitas na versão v3 da API são versionadas seguindo um esquema de versão de calendário (por exemplo, 2018-11-06 ). A versão pode ser definida globalmente para sua organização ou especificada por solicitação por meio do cabeçalho Ricloud-Version .

Recursos Deletáveis

A maioria dos recursos não pode ser excluída, o que significa que eles só podem ser desativados pela organização proprietária ou bloqueados por um administrador da API.