La Minitab Connect API

Resumen de una solicitud de API

Cada extremo tiene una lista específica de atributos que contienen valores, algunos compartidos y otros únicos, contra los cuales pueden buscarse mediante la solicitud de búsqueda de la versión 3 de la API. Para recibir la lista de atributos de un endpoint, escribe una solicitud sencilla de API versión 3. Una solicitud API versión 3 para atributos del endpoint solo requiere tres datos básicos: URL base, endpoint y clave API.

Base URL

La URL base es la misma independientemente de la solicitud específica de API que se realice. Para determinar cuál debe ser tu URL base, simplemente copia la URL que utilices para iniciar sesión en Minitab Connect. Por ejemplo, si usas https://connect.minitab.com para acceder Minitab Connecta , entonces la URL base para todas tus solicitudes de API es: https://connect.minitab.com/api/3/.

Punto final

Representa el objeto o la colección de objetos con los que la solicitud pretende interactuar. En el ejemplo anterior, el punto final en la 'Solicitud de API de ejemplo' es 'Fuente'. Esto limitará lo que se puede hacer con la petición de la API a Acciones diseñadas específicamente para manipular objetos de datos 'Fuente'.

Por ejemplo, el endpoint en https: connect.minitab.com/Source/?apikey=12478781287471824&action=search&arg=[{"nombre":"Campañas"}] es 'Fuente'. Esto limitará lo que se puede hacer con la solicitud de API a acciones diseñadas específicamente para manipular objetos de datos 'Fuente'.

GUID de punto final

El GUID del endpoint es un identificador único que representa un objeto de datos específico dentro de Minitab Connect. El GUID consta de una cadena única de caracteres y a veces se denomina 'Clave'. Para encontrar el GUID en Minitab Connect, abre el Editar modal del objeto deseado. El GUID del endpoint no es necesario para todas las solicitudes de API. Por ejemplo, una solicitud API que realiza una acción de búsqueda omite el GUID del endpoint.

Clave API

Esta parte de la Solicitud API informa al sistema de que la solicitud debe procesarse con los mismos permisos que el usuario especificado. Esto siempre estará representado por un GUID. Una clave API es una cadena única de caracteres asociada a un usuario específico de Minitab Connect. Para encontrar tu GUID, primero inicia sesión en el sistema. Después, abre el Usuario botón en la esquina superior derecha y selecciona Configuración de la cuenta. Se muestra una lista de claves API disponibles con la capacidad de generar nuevas. (En este ejemplo, se utiliza una clave API ficticia con fines de seguridad)

Autenticación

Informa al sistema de que la solicitud debe procesarse con los mismos permisos que el usuario especificado. La autenticación se representa mediante una clave API. Una clave API es una cadena única de caracteres que se crea para dar acceso a una característica de la herramienta. Para crear una clave de API, abre el Usuario botón en la esquina superior derecha y selecciona Configuración de la cuenta. Para obtener más información, vaya a Generar un token API.

Acción

Especifica qué acciones realizar para el endpoint especificado. Las acciones suelen categorizarse de la siguiente manera:

• Receptores: Las acciones getter se utilizan para extraer datos del sistema. Cada extremo tiene un conjunto único de getters. Para usar un getter, el formato correcto es: action= donde se reemplaza por el nombre del getter deseado.
• Colocadores: Las acciones del setter se utilizan para importar datos al sistema y para establecer o cambiar propiedades de un objeto de datos. Cada extremo tiene un conjunto único de setters. Para usar un colocador, el formato correcto es: acción=&arg= donde se reemplaza por el nombre del colocador deseado y es el valor a establecer.
• Acciones: Las acciones se utilizan para procesos, características o comandos de un objeto de datos que no cumplen con las características de un getter. Un ejemplo de acción es añadir campos a una tabla. Cada acción tiene requisitos diferentes. Por ejemplo, algunas acciones no requieren argumentos y están formateadas de la misma manera que un getter. Otras acciones requieren que los argumentos estén formateados como un colocador.
• Búsquedas: Las búsquedas se utilizan para obtener datos de un punto final que cumple un conjunto específico de parámetros. Las búsquedas pueden tener un número infinito de términos de búsqueda y están formateadas como un array. Por ejemplo: action=search&args=[{"fname":"John", "lname":"Smith"}] solo devolvería registros donde [ "fname" (nombre de pila) es "John" Y "lname" (apellido) es "Smith". Puedes usar cualquier número de términos de búsqueda siempre que encajen en la estructura clave:valor y estén separados por comas.

  Nota

  Al añadir los valores a la solicitud de búsqueda de la API, las cadenas de texto deben estar dentro de comillas.

Puedes hacer una solicitud API que contenga múltiples acciones. Para ello, separa cada acción con un ventaventaz ('&'). Por ejemplo, necesitas cambiar el nombre de pila, segundo nombre y apellido de un usuario que tenga un ID de 15. La petición es así:

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

Esta petición establece el nombre como "John",el segundo nombre como "D" y el apellido como "Smith" en el usuario con ID 15.

Nota

Al usar múltiples acciones en una sola solicitud de API, la acción debe incrementarse. La primera acción y argumento pueden añadirse con un 0 o un 1. Cada agrupación adicional de acciones debe incrementarse por un factor de 1.

Solicitud de API para devolver todas las acciones de un endpoint

En cualquier momento se puede hacer una solicitud API que devolverá una lista de todas las acciones disponibles para un endpoint específico. La solicitud es la siguiente:

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

Sustituye el endpoint por el endpoint específico y la apikey por una clave API real. Se devolverá un objeto JSON que contiene todas las acciones del endpoint así como todos los atributos.

Puntos finales actuales y descripciones

En cualquier momento, puedes hacer una solicitud API que devuelva una lista de todos los endpoints. La solicitud es la siguiente:

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