Visão geral (v2)

Atualizada

Introdução

Existem quatro serviços que compreendem e são usados para interagir com a API do ricloud : asmaster , asapi , aschannel e asstore . Os clientes geralmente só interagem com dois desses serviços em vez de todos os quatro.

A API pode ser controlada de duas maneiras: com asmaster ou asapi . Os resultados são recebidos do aschannel (um fluxo firehose para recuperação de dados em tempo real) ou asstore (um depósito para recuperação de dados em lote).

Componente Entrega de resultados Mais adequado para Gerenciamento de token
asmaster aschannel Recuperação Regular de Dados Reincubar
asapi aschannel ou asstore Acesso pouco frequente a pequenos volumes Diferido para o cliente

Acesso a dados em tempo real

Com o asmaster , os clientes registram contas ou dispositivos de interesse e, em seguida, recebem novos dados em um fluxo em tempo real quando se tornam disponíveis. O asmaster é efetivamente um controlador inteligente para o asapi , que reduz ainda mais a necessidade do cliente de entender a mecânica de armazenamento e recuperação de dados, e que pode fornecer dados mais rapidamente e com segurança do que um cliente com sua própria implementação contra o asapi .

Dependendo do tipo de dados e da origem subjacentes, o asmaster inscreve-se internamente em um feed upstream de dados para atualizações em tempo real ou usa um planejador inteligente preditivo para gerenciar as pesquisas.

Acesso a dados próximos e em lote

Com o asapi , os clientes solicitam dados de contas ou dispositivos quando e como quiserem, depois recebem dados quando estão prontos em um fluxo ou pesquisando um intervalo .

Conceitos e serviços

A API ricloud é modelada em torno de quatro conceitos principais: ações , tarefas , serviços e contas .

Ações são a unidade básica de trabalho realizada pela API; cada ação é associada a um serviço . Por exemplo, pode-se executar a ação fetch_data , parte do serviço icloud . Toda ação é executada contra uma conta . As contas representam contas de usuário final para qualquer dado de serviço que esteja sendo recuperado. Uma conta é acessível a um cliente se tiver sido registrada por esse cliente. Cada instância de uma ação é descrita como uma tarefa e alocada a task_id .

Mestre do fluxo de aplicativos ( asmaster )

asmaster é um mecanismo de controle de assinatura para a API. Ele permite que os usuários:

  • Descubra serviços , ações e endpoints que eles estão autorizados a usar
  • Registre-se, cancele o registro e aprenda sobre contas
  • Inscreva-se e cancele a inscrição em feeds automáticos de dados de contas

Com essa abordagem, o asmaster gera automaticamente tarefas para o asapi e os dados resultantes são obtidos a partir do aschannel .

A documentação detalhada para o asmaster está disponível na inscrição de dados com o asmaster .

App stream API ( asapi )

O asapi é um mecanismo de controle assíncrono para a API. Ele permite que os usuários:

  • Descubra serviços , ações e endpoints que eles estão autorizados a usar
  • Registre-se, cancele o registro e aprenda sobre contas
  • Enviar tarefas assíncronas
  • Consultar o status das tarefas

Depois de concluídos, os dados das tarefas podem ser obtidos a partir de aschannel ou asstore , dependendo do caso de uso do cliente.

A documentação detalhada do asapi está disponível para solicitar dados com o asapi .

Canal de fluxo de aplicativo ( aschannel )

aschannel é um endpoint de streaming, que permite aos clientes recuperar os resultados de cada tarefa submetida, em tempo real, à medida que são gerados.

Os resultados são recuperados abrindo uma conexão ao ponto final aschannel .

  • Os resultados são transmitidos no formato JSON
  • Assim que estiverem disponíveis, podem ser recuperados do serviço
  • O canal é sem estado; Se um cliente perder a transmissão de um resultado, ele não poderá ser repetido sem reenvio da tarefa.

Documentação detalhada de aschannel está disponível em dados de streaming com aschannel .

Armazenamento de fluxo de aplicativo ( asstore )

O asstore é um repositório de resultados limitado no tempo, que permite aos clientes recuperar os resultados das tarefas enviadas conforme e quando estiverem disponíveis.

  • Os resultados são armazenados por um período limitado antes de serem expirados e excluídos
  • Um resultado só pode ser baixado uma vez; é deletado uma vez consumido

A documentação detalhada do asstore está disponível para download de dados com asstore .

Padrões usados

Por todo o ricloud e sua documentação, são utilizados os seguintes padrões:

  • A API usa consistentemente datas no formato ISO-8601 , no fuso horário UTC . Por exemplo, 24 de dezembro seria expresso como 2014-12-24 17:30:00.000000 .
  • Dados estruturados retornados pelos componentes do ricloud sempre usam JSON . Isso é invariavelmente indicado pelo tipo de conteúdo application/json nas respostas.
  • Os exemplos de comandos nesta documentação são fornecidos no formato bash , usando o comando curl .

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 5:05 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.