A Minitab Connect API

Visão geral de uma requisição de API

Cada endpoint possui uma lista específica de atributos que contêm valores, alguns compartilhados e outros únicos, que podem ser pesquisados usando a solicitação de busca da API versão 3. Para receber a lista de atributos de um endpoint, escreva uma solicitação simples de API versão 3. Uma solicitação de API versão 3 para atributos de endpoint requer apenas três informações básicas: url base, endpoint e chave API.

Base URL

A URL base é a mesma independentemente da solicitação específica da API feita. Para determinar qual deve ser sua URL base, basta copiar a URL que você usa para fazer login em Minitab Connect. Por exemplo, se você usar https://connect.minitab.com para acessar Minitab Connect, então a URL base para todas as suas requisições de API é: https://connect.minitab.com/api/3/.

Endpoint

Representa o objeto ou coleção de objetos com os quais a solicitação pretende interagir. No exemplo acima, o endpoint na 'Request API de exemplo' é 'Source'. Isso limitará o que pode ser feito com a requisição da API a Ações especificamente projetadas para manipular objetos de dados 'Fonte'.

Por exemplo, o endpoint em https: connect.minitab.com/Source/?apikey=12478781287471824&action=search&arg=[{"nome":"Campanhas"}] é 'Fonte'. Isso limitará o que pode ser feito com a requisição da API a ações especificamente projetadas para manipular objetos de dados 'Fonte'.

GUID de ponto final

O GUID endpoint é um identificador único que representa um objeto de dados específico dentro Minitab Connectde . O GUID consiste em uma sequência única de caracteres e às vezes é chamado de 'Chave'. Para encontrar o GUID em Minitab Connect, abra o Editar modal para o objeto desejado. O GUID do endpoint não é necessário para todas as requisições de API. Por exemplo, uma requisição de API que executa uma ação de busca omite o GUID do endpoint.

Chave API

Essa parte da Solicitação API informa ao sistema que a solicitação deve ser processada com as mesmas permissões do usuário especificado. Isso sempre será representado por um GUID. Uma chave API é uma única cadeia de caracteres associada a um usuário específico de Minitab Connect. Para encontrar seu GUID, primeiro faça login no sistema. Em seguida, abra o Usuário botão no canto superior direito e selecione Configurações da conta. Uma lista de chaves de API disponíveis é listada com a capacidade de gerar novas. (Neste exemplo, uma chave de API fictícia é usada para fins de segurança)

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 criada para dar acesso a uma funcionalidade da ferramenta. Para criar uma chave de API, abra o Usuário botão no canto superior direito e selecione Configurações da conta. Para mais informações, acesse Gerar um token de API.

Ação

Especifica quais ações tomar para o endpoint especificado. As ações geralmente são categorizadas da seguinte forma:

• Acertadores: Ações getter são usadas para extrair dados do sistema. Cada endpoint possui um conjunto único de getters. Para usar um getter, o formato correto é: action= onde é substituído pelo nome do getter desejado.
• Levantadores: As ações do setter são usadas para importar dados para o sistema e para definir ou alterar propriedades de um objeto de dados. Cada extremidade possui um conjunto único de setters. Para usar um setter, o formato correto é: action=&arg= onde é substituído pelo nome do setter desejado e é o valor a ser definido.
• Ações: Ações são usadas para processos, recursos ou comandos de um objeto de dados que não atendem às características de um getter. Um exemplo de ação é adicionar campos a uma tabela. Cada ação tem requisitos diferentes. Por exemplo, algumas ações não requerem argumentos e são formatadas da mesma forma que um getter. Outras ações exigem que os argumentos sejam formatados como um setter.
• Buscas: Buscas são usadas para obter dados de um endpoint que atenda a um conjunto específico de parâmetros. Buscas podem ter um número infinito de termos de busca e são formatadas como um array. Por exemplo: action=search&args=[{"fname":"John", "lname":"Smith"}] só retornaria registros onde [ "fname" (primeiro nome) é "John" E "lname" (sobrenome) é "Smith". Você pode usar qualquer número de termos de busca, desde que se encaixem na estrutura chave:valor e estejam separados por vírgulas.

  Observação

  Ao adicionar os valores à solicitação de busca da API, as strings de texto devem estar dentro das aspas.

Você pode fazer uma requisição de API que contenha múltiplas ações. Para isso, separe cada ação com um ampersand ('&'). Por exemplo, você precisa mudar o nome, nome do meio e sobrenome de um usuário que tenha ID 15. O pedido é o seguinte:

https://connect.minitab.com/api/3/User/15?apikey=45a3d34982e&action0=setFName&arg0=John&action1=setMName&arg1=D&action2=setLName&arg2=Smith

Essa solicitação define o Primeiro Nome igual a "John",o Nome do Meio igual a "D" e o Sobrenome igual a "Smith" no Usuário que tem ID 15.

Observação

Ao usar múltiplas ações em uma única requisição de API, a ação deve ser incrementada. A primeira ação e argumento podem ser acrescentados com 0 ou 1. Cada agrupamento adicional de ações deve incrementar por um fator de 1.

Solicitação de API para retornar todas as ações de um endpoint

A qualquer momento, uma requisição de API pode ser feita retornando uma lista de todas as ações disponíveis para um endpoint específico. O pedido é o seguinte:

https://connect.minitab.com/api/3/[endpoint]/?apikey=[apikey]

Substitua o endpoint pelo endpoint específico e o apikey por uma chave API real. Um objeto JSON será retornado contendo todas as ações do endpoint, bem como todos os atributos.

Pontos finais e descrições atuais

A qualquer momento, você pode fazer uma requisição de API que retornará uma lista de todos os endpoints. O pedido é o seguinte:

https://connect.minitab.com/api/3/?apikey=[apikey]