visão global

Atualizada

This is the documentation for Reincubate's ricloud API. The API provides users access to their own data in Apple's iCloud and local iTunes backups via the Reincubate Relay app.

For product information see the ricloud API product page.

Conceitos chave

Recursos

The API is organised into a set of resources. A client can create, retrieve, update and destroy (CRUD) these to configure, trigger, and monitor operations on the API. See the API resource reference for more details.

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

Notification of asynchronous operation completion is handled via webhooks, whereby events are sent to a client's server through standard HTTP requests. These events contain information on where to find requested data within a client's bucket, allowing the client to make a decision on when and how to use it.

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

These are specific sources of data within a service. An iCloud account is the primary source of the iCloud service, whereas a Reincubate Relay app instance is the primary source of the Reincubate Relay service.

Do utilizador

A user represents the end-user that is requesting data. In many cases, this will be a user of your application.

Sessão

A session represents access to a specific source, and one is needed in order to retrieve any information or data from the source through the API.

Creating a session is the equivalent of a 'login' into an iCloud account or 'pairing' with a Reincubate Relay app instance.

The API will execute the session initialisation process asynchronously. This means the call to create a session will return immediately, but the session will not be ready to use until initialisation has completed.

Votação

Polls are how users can request data through the API. An active session against the targeted source is needed for a poll to be created.

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

These are the underlying chunks of work performed by the API. When a session is created, it also creates a task in order to perform any initialisation against external services. When a poll is created, it will create at least one task to perform any necessary work.

Result

A result is a reference to data or a file published to a client's storage bucket.

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 2:29 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 - 2020 Reincubate Ltd. Todos os direitos reservados. Registrado na Inglaterra e no País de Gales #5189175, VAT GB151788978. Reincubate® é uma marca registrada. Política de Privacidade & termos. Recomendamos 2FA. Construído com em Londres.