visão global
Esta é a documentação para a API ricloud do Reincubate. A API fornece aos usuários acesso a seus próprios dados nos backups iCloud e iTunes locais da Apple, por meio do aplicativo Reincubate Relay.
Para obter informações sobre o produto, consulte a página do produto API ricloud .
Conceitos chave
Recursos
A API está organizada em um conjunto de recursos. Um cliente pode criar, recuperar, atualizar e destruir (CRUD) para configurar, acionar e monitorar operações na API. Consulte a referência de recurso da API para obter mais detalhes.
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 da conclusão da operação assíncrona é tratada por meio de webhooks, nos quais os eventos são enviados ao servidor de um cliente através de solicitações HTTP padrão. Esses eventos contêm informações sobre onde encontrar os dados solicitados no intervalo de um cliente, permitindo que o cliente tome uma decisão sobre quando e como usá-lo.
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
Essas são fontes específicas de dados em um serviço. Uma conta do iCloud é a fonte principal do serviço iCloud, enquanto uma instância do aplicativo Reincubate Relay é a fonte primária do serviço Reincubate Relay.
Do utilizador
Um usuário representa o usuário final que está solicitando dados. Em muitos casos, este será um usuário do seu aplicativo.
Sessão
Uma sessão representa o acesso a uma fonte específica e é necessária uma para recuperar qualquer informação ou dado da fonte através da API.
Criar uma sessão é equivalente a um 'login' em uma conta do iCloud ou 'emparelhamento' com uma instância do aplicativo Reincubate Relay.
A API executará o processo de inicialização da sessão de forma assíncrona. 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
As pesquisas são sobre como os usuários podem solicitar dados por meio da API. É necessária uma sessão ativa contra a fonte de destino para que uma pesquisa seja criada.
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
Esses são os blocos de trabalho subjacentes executados pela API. Quando uma sessão é criada, ela também cria uma tarefa para executar qualquer inicialização em serviços externos. Quando uma pesquisa é criada, ela cria pelo menos uma tarefa para executar qualquer trabalho necessário.
Resultado
Um resultado é uma referência a dados ou um arquivo publicado no bucket de armazenamento de um cliente.
