A Minitab Connect API OData

Base URL

A URL base é a mesma independentemente da requisição específica da API que você faça. Para determinar qual deve ser sua URL base, copie a URL que você usa para fazer login no Minitab Connect e adicione /api/odata_v4/. Por exemplo, se você usar https://connect.minitab.com para acessar o Minitab Connect, então a URL base para todas as suas requisições da API OData é: https://connect.minitab.com/api/odata_v4/.

Métodos de autenticação

Informa ao sistema que a solicitação deve ser processada com as mesmas permissões do usuário especificado. A autenticação é representada por uma Chave de API. Uma Chave de API é uma sequência única de caracteres que dá acesso a uma funcionalidade na ferramenta. Para criar uma chave de API, abra Usuário o menu no canto superior direito e selecione Configurações da conta. Para obter mais informações, vá para Gerar um token de API.

Existem três métodos diferentes de autenticação.

Chave API de String de Consulta

Um parâmetro GET ou POST chamado 'apikey' que contém um token gerado pela página de Configurações de Conexão de Conta. Por exemplo, https://connect.minitab.com/api/odata_v4/?apikey=[apikey], onde você substitui 'apikey' pela chave real da API.

Chave API de cabeçalho

Um cabeçalho HTTP chamado 'X-Api-Key' que contém um token gerado pela página de Configurações de Conexão de Conta.

Autenticação Web Básica

Seu nome de usuário é seu nome de usuário ou endereço de e-mail do Connect. A senha é um token que a página de Configurações de Conexão de Conta gera.

Extremidade

Endpoint base - https://connect.minitab.com/api/odata_v4/

Retorna uma lista de conjuntos de entidades que são as tabelas e views às quais o usuário tem acesso.

Observação

Conecte os remotos todos os caracteres que não sejam A-Z, a-z, 0-9, acc-(hífen) e _(sublinhado) de entidades (registros), conjuntos de entidades (tabelas e visualizações) e propriedades. Connect adiciona "_t" para tabelas e "_v" para visualizações, além de um ID para os nomes de conjunto de entidades e entidades para garantir um nome único. Por exemplo:

• TableName_t38
• ViewName_v2

Endpoint de metadados - https://connect.minitab.com/api/odata_v4/$metadata

Retorna a definição de dados XML de todas as entidades, conjuntos de entidades e propriedades.

Endpoint Entity Set - https://connect.minitab.com/api/odata_v4/[EntitySet]

Retorna registros do conjunto de entidades (tabela ou visualização). Por padrão, a ordem corresponde à ordem na Base ou à ordem na Visualização. Substitua o 'EntitySet' pelo nome correspondente da tabela ou visualização do Minitab Connect. Você pode retornar os nomes de todas as tabelas e views do Endpoint Base.

O endpoint do conjunto de entidades atualmente suporta apenas três funções:

$count - https://connect.minitab.com/api/odata_v4/[EntitySet]/?$count

Retorna o número de registros

$top - https://connect.minitab.com/api/odata_v4/[EntitySet]/?$top=[número]

Retorna registros de 'número' do conjunto de entidades. Tanto o padrão quanto o máximo são 5.000 registros. Você pode combinar com $skip para folhear todos os registros.

$skip - https://connect.minitab.com/api/odata_v4/[EntitySet]/?$skip=[número]

Pula registros de 'números'. Você pode combinar com $top para folhear todos os registros.

Observação

O endpoint do conjunto de entidades atualmente não suporta as funções $filter, $select, $orderby ou $expand. Você pode criar o mesmo efeito de $filter, $select e $orderby usando a Preparar ferramenta Minitab Connect e criando uma visualização salva da sua tabela.

Endpoint da entidade - https://connect.minitab.com/api/odata_v4/[EntitySet]([sys_id])/

Retorna uma entidade (um registro), identificada por 'sys_id', do 'EntitySet' especificado.