La Minitab Connect API OData

El Protocolo de Datos Abiertos (OData) define un conjunto de mejores prácticas para construir y consumir APIs RESTful. Minitab Connect La API de la versión 4 de OData ha facilitado más que nunca conectarse desde cualquier fuente externa. Actualmente, los datos son de solo lectura. No puedes hacer ninguna actualización de los datos a través de esta API.
Nota

Un solo usuario no puede realizar solicitudes API más de 20 veces por segundo ni 1.000 por minuto. Todos los usuarios con una suscripción Connect no pueden hacer más de 200 solicitudes por segundo ni 10.000 por minuto.

Base URL

La URL base es la misma independientemente de la solicitud API específica que hagas. Para determinar cuál debería ser tu URL base, copia la URL que uses para iniciar sesión en Minitab Connect y añade /api/odata_v4/. Por ejemplo, si usas https://connect.minitab.com para acceder a Minitab Connect, entonces la URL base de todas tus solicitudes API de OData es: https://connect.minitab.com/api/odata_v4/.

Métodos de 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 da acceso a una función de la herramienta. Para crear una clave API, abre Usuario el menú en la esquina superior derecha y selecciona Configuración de la cuenta. Para obtener más información, vaya a Generar un token API.

Existen tres métodos de autenticación diferentes.

Clave API de cadena de consulta
Un parámetro GET o POST llamado 'apikey' que contiene un token que genera la página de Configuración de la Cuenta de Conectar. Por ejemplo, https://connect.minitab.com/api/odata_v4/?apikey=[apikey], donde reemplazas 'apikey' por la clave API real.
Clave API de cabecera
Un encabezado HTTP llamado 'X-Api-Key' que contiene un token que genera la página de Configuración de la Cuenta de Conectar.
Autenticación web básica
Tu nombre de usuario es tu usuario o dirección de correo electrónico en Connect. La contraseña es un token que genera la página de Configuración de Conexión de Cuenta.

Extremos

Punto final base - https://connect.minitab.com/api/odata_v4/
Devuelve una lista de conjuntos de entidades que son las tablas y vistas a las que el usuario tiene acceso.
Nota

Conecta los mandos a distancia todos los caracteres que no sean A-Z, a-z, 0-9, acc-(guion) y _(guion) de entidades (registros), conjuntos de entidades (tablas y vistas) y propiedades. Connect añade "_t" para tablas y "_v" para vistas, además de un ID a los nombres de conjunto de entidades y entidades para garantizar un nombre único. Por ejemplo:

  • TableName_t38
  • ViewName_v2

Endpoint de metadatos - https://connect.minitab.com/api/odata_v4/$metadata
Devuelve la definición de datos XML de todas las entidades, conjuntos de entidades y propiedades.
Endpoint Entity Set - https://connect.minitab.com/api/odata_v4/[EntitySet]
Retorna los registros del conjunto de entidades (tabla o vista). Por defecto, el orden coincide con el orden en Base o con el orden en la Vista. Sustituye el 'EntitySet' por el nombre correspondiente de la tabla o vista de Minitab Connect. Puedes devolver los nombres de todas las tablas y vistas desde el Punto Final Base.
Actualmente, el endpoint del conjunto de entidades solo soporta tres funciones:
$count - https://connect.minitab.com/api/odata_v4/[EntitySet]/?$count
Devuelve el número de registros
$top - https://connect.minitab.com/api/odata_v4/[EntitySet]/?$top=[número]
Devuelve los registros de 'número' del conjunto de entidades. Tanto el valor predeterminado como el máximo son 5.000 registros. Puedes combinarla con $skip para hojear todos los registros.
$skip - https://connect.minitab.com/api/odata_v4/[EntitySet]/?$skip=[número]
Salta los registros de 'números'. Puedes combinarlo con $top para hojear todos los registros.
Nota

El extremo del conjunto de entidades actualmente no soporta las funciones $filter, $select, $orderby o $expand. Puedes crear el mismo efecto de $filter, $select y $orderby usando la Prep herramienta Minitab Connect y creando una vista guardada de tu tabla.

Punto final de la entidad - https://connect.minitab.com/api/odata_v4/[EntitySet]([sys_id])/

Devuelve una entidad (un registro), identificada por 'sys_id', del 'EntitySet' especificado.