Carol

Árvore de páginas


CONTEÚDO

  1. Visão geral
  2. Exemplo de utilização
  3. Tela Carol API Platform
    1. Outras ações / Ações relacionadas
    2. Principais campos e parâmetros
  4. Tabelas utilizadas


01. VISÃO GERAL

Esta documentação tem como objetivo apresentar os principais serviços da Carol para construção de uma integração para o envio de dados à Carol. Também é coberto o processo de consumo de dados e o entendimento de como extrair os dados de Golden Records.

02. EXEMPLO DE UTILIZAÇÃO

Siga os passos abaixo para a construção de uma integração que faça o envio de dados à Carol e o posterior consumo destes dados, já saneados e consolidados (Golden Records), dentro da sua aplicação:

  1. Swagger
  2. Autenticação
  3. Enviando Dados para TOTVS Carol 
  4. Consumindo Dados TOTVS Carol
  5. Detalhes Golden Record
  6. Habilitando camada SQL na Carol
  7. Consumindo Dados TOTVS Carol usando SQL
  8. Consumindo Dados através Data Subscription

03. TELA CAROL API PLATFORM

Outras Ações / Ações relacionadas

AçãoDescrição
Autorizar (Authorize)

Quando acionado apresenta a tela Autorizações Disponíveis (Available authorizations), no qual é possível definir as permissões para a utilização de determinadas operações constituídas de endpoints para um web service. 


SAIBA MAIS

Endpoints são pontos de comunicação de acesso a uma aplicação, e um web service é a URL onde seu serviço pode ser acessado por uma aplicação cliente com ou sem uso de uma API.  Uma API é um conjunto de rotinas, protocolos e ferramentas para construir aplicações.

Explorar (Explore)Quando acionado atualiza a tela principal utilizando-se dos parâmetros informados nos campos no topo da página. 
Esquemas (Schemes)Quando acionado apresenta uma lista com os protocolos de comunicação permitidos para escolha.
GetQuando acionado solicita a representação de um recurso específico. Requisições HTTP utilizando o método GET devem retornar apenas dados.
PostQuando acionado submete uma entidade a um recurso específico, frequentemente causando uma mudança no estado do recurso ou efeitos colaterais no servidor.
PutQuando acionado substitui todas as atuais representações do recurso de destino pela carga de dados da requisição.
DeleteQuando acionado remove um recurso específico.


Principais Campos e Parâmetros

A explicação sobre os principais serviços, campos e parâmetros pode ser encontrada em documentação complementar da Plataforma Carol, acessando o seguinte endereço: https://docs.carol.ai/docs/1-swagger#overview.

04. TABELAS UTILIZADAS