import swaggerui from './/img/swagger-ui.png';

Swagger

O Swagger é um framework para a construção, documentação, e consumo de serviços REST APIs. Ele pode ser acessado através do cabeçalho da Plataforma Carol no ícone {⋮}.

→ Acesse aqui a página do Swagger

Tipos de acesso

Cada tipo de acesso ao Swagger apresenta diferentes funcionalidades. O tipo de acesso pode ser alterado no cabeçalho. As principais diferenças são:

• Acesso de UI
  Acesso aos serviços necessários para a integração de aplicativos com a Carol, contemplando diversos benefícios de processos, como autenticação, ingestão e consumo de dados.

• Acesso de Admin
  Acesso aos serviços necessários e avançados para a integração de aplicativos com a Carol, contemplando serviços ligados aos Carol Apps, processamento de dados, segurança, privacidade de dados, entre outros.
  Grande parte dos serviços disponíveis nesta seção já estão disponíveis na Plataforma Carol.

• Acesso SQL
  No Swagger SQL estão concentrados os serviços responsáveis por habilitar funcionalidades nas Tenants, como: habilitar o BigQuery, modificar uma tabela no BigQuery, copiar dados de uma Tenant cliente para unificada, criar service account para acessar ao BigQuery, e várias outras ações que dão poderes ao usuário ou à Tenant sobre o BigQuery ou outro serviço do Google.

• Acesso SQL Query
  No Swagger SQL Query, estão concentrados apenas os serviços que dão acesso ao dados do BigQuery através de consultas de queries customizadas ou buscas simples.

Ações e conceitos

• Override Auth token
  É possível alterar o Auth token inserindo outro valor e confirmando. Além disso é possível utilizar outro ID de Organização e também de Tenant.

• Endpoints e API
  Endpoints são pontos de comunicação de acesso à uma aplicação, e um web service é a URL onde o 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.

• Get
  Usado para solicitar a representação de um recurso específico. Requisições HTTP utilizando o método GET devem retornar apenas dados.

• Post
  Usado para submeter uma entidade à um recurso específico, frequentemente causando uma mudança no estado do recurso ou efeitos colaterais no servidor.

• Put
  Usado para substituir todas as atuais representações do recurso de destino pela carga de dados da requisição.

• Delete
  Usado para remover um recurso específico.