Protocolos

Atualizada

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:

Publicação Criptografada

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

Tipos de atributos

Todos os atributos de datetime sempre serão formatados de acordo com a especificação ISO8601. A API retorna todos os atributos datetime com o fuso horário UTC. Portanto, o formato esperado é "2018-08-22T10:25:05Z" .

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.

Como podemos ajudar?

Nossa equipe de suporte está aqui para ajudar!

Nosso horário de atendimento é de segunda a sexta, das 9h às 17h GMT. A hora é atualmente 3:21 PM GMT.

Nosso objetivo é responder a todas as mensagens dentro de um dia útil.

Vá para a seção de apoio › Entre em contato com a equipe da empresa ›
Nossa equipe de suporte incrível

© 2008 - 2019 Reincubate Ltd. Todos os direitos reservados. Registrado na Inglaterra e no País de Gales #5189175, VAT GB151788978. Reincubate® é uma marca registrada. Privacidade e Termos. Recomendamos 2FA. Construído com em Londres.