visão global

Atualizada

A é a documentação para a terceira versão da API ricloud do Reincubate . A API fornece um mecanismo para que os usuários acessem facilmente os dados do aplicativo a partir de uma variedade de fontes de dados, incluindo o iCloud da Apple e o backup local do iTunes via asrelay .

Para informações sobre produtos, consulte a página do produto ricloud .

Termos chave

Antes de mergulhar na seção inicial, é útil estar familiarizado com um punhado de termos e conceitos que serão utilizados em todo o processo.

Serviço

Um serviço descreve uma coleção de fontes de dados disponíveis por meio da API. Isso inclui serviços de terceiros, como produtos do iCloud ou Reincubate, como asrelay .

Serviços diferentes terão requisitos variados para determinados recursos na API, além de alterar o ciclo de vida geral dos objetos da API. Por exemplo, a carga útil necessária para criar uma sessão para o serviço iCloud difere da necessária no serviço asrelay .

Fonte

Estas são fontes específicas de dados dentro de um serviço. Uma conta do iCloud é a principal fonte do serviço iCloud, enquanto uma instância do cliente asrelay é a principal fonte do serviço asrelay .

Em muitos casos, um serviço terá uma hierarquia de fontes que podem ser direcionadas individualmente. Por exemplo, o serviço iCloud possui fontes de contas e fontes de dispositivos.

Do utilizador

Um usuário deve sempre representar o usuário final que está solicitando dados. Em muitos casos, isso será um usuário do seu aplicativo.

Sessão

Uma sessão representa o acesso a uma fonte específica e é necessária para recuperar informações ou dados da fonte por meio da API.

Criar uma sessão é o equivalente de um 'login' em uma conta do iCloud ou 'emparelhamento' com uma instância do cliente asrelay .

A API executará o processo de inicialização da sessão de forma assíncrona por meio de uma tarefa. Isso significa que a chamada para criar uma sessão retornará imediatamente, mas a sessão não estará pronta para uso até que a inicialização seja concluída.

Votação

Pesquisas são como os usuários podem solicitar dados por meio da API. Uma sessão ativa contra a fonte segmentada é necessária para que uma pesquisa seja configurada.

Todas as pesquisas são processadas de forma assíncrona por meio de uma ou mais tarefas e os resultados são publicados nos intervalos de armazenamento em nuvem configurados em sua organização.

Tarefa

Estes são os trechos subjacentes do trabalho realizado pela API. Quando uma sessão é criada, ela também cria uma tarefa para executar qualquer inicialização contra serviços externos. Quando uma pesquisa é criada, ela cria pelo menos uma tarefa para executar o trabalho de recuperação de dados.

Conceitos chave

Recursos

A API é organizada em torno de um conjunto de recursos descritos na referência de recursos da API. Por meio desses recursos, um cliente da API é capaz de: personalizar a configuração da API, inicializar o acesso à fonte de dados e recuperar dados dessas origens.

Processamento assíncrono

A API depende de operações assíncronas para configurar sessões em serviços de terceiros e processamento de dados. Isso permite que você gerencie uma grande quantidade de demanda de dados enquanto interage com os serviços externos de maneira responsável. Também oferece flexibilidade extra para reagir a flutuações nos tempos de resposta ou degradação de serviços de terceiros.

Publicação de bucket de armazenamento

Os dados solicitados da API são publicados diretamente no intervalo de um cliente no Google Cloud Storage ou no Amazon S3. Isso ajuda a minimizar os problemas relacionados ao dimensionamento da entrega de dados e também permite a recuperação mais rápida de dados, pois é menos provável que a publicação se torne um gargalo.

Notificações do Webhook

A notificação de conclusão de operação assíncrona é tratada por meio de um mecanismo de webhook, em que os eventos são enviados para o servidor de um cliente por meio de solicitações HTTP padrão. Esses eventos contêm informações sobre onde localizar dados solicitados no intervalo de um cliente, permitindo que o cliente tome uma decisão sobre quando e como usá-lo.

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 1:12 AM 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

Podemos melhorar este artigo?

Adoramos ouvir os usuários: por que não nos enviar um e-mail, deixar um comentário ou twittar? @reincubate?

© 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.