Obtener una clave API

Las claves API se utilizan para permitir que el código realice solicitudes a Instrumental, ya sea para cargar o recuperar datos. Para obtener una clave API y utilizarla para acceder a las API instrumentales, deberá trabajar con su arquitecto de soluciones instrumentales. Instrumental le permitirá proporcionar sus propias claves API o las proporcionará por usted. De cualquier manera, su contacto Instrumental puede permitirle acceder al modo que se muestra a continuación para que pueda ver qué claves están activas y dónde se están utilizando.

Tabla de contenidos

Agregar una clave

En el modo Claves API, puede hacer clic en el botón morado “AGREGAR CLAVE” para obtener una nueva clave. Se abrirá un modal que le mostrará su nueva clave. Esta es la única vez que Instrumental mostrará la clave completa, así que asegúrese de guardarla.

Las claves API tienen este aspecto:

nombre-proyecto:nombre-clave:INST:V1:F854DS4QEVIXS4:gZB5txLjMD2+hUjJdzsPI6YOFYkmIQtLebCgLlvS

Trate las claves API como contraseñas,porque eso es lo que son. Ten cuidado al compartirlos.

La clave consta de varias partes separadas por dos puntos:

El nombre del proyecto (más específicamente, la versión "slugificada" que aparece en la URL de la aplicación web) ayuda a garantizar que cuando utilice una clave, esté cargando datos en el proyecto correcto. El nombre del proyecto es opcional (la clave seguirá funcionando si la omites), pero si está presente, debe coincidir con el proyecto al que está realmente asignada la clave.
El nombre de la clave ayuda a identificar para qué se utiliza la clave. Por ejemplo, si tiene varias fábricas, probablemente generará una clave diferente para cada una y puede usar el campo de nombre de clave para asegurarse de enviar cada clave al lugar correcto. Otro uso común es identificar claves que se utilizan en diferentes estaciones. El campo de nombre de clave es opcional: la clave seguirá funcionando si la omite y, de hecho, se omite de forma predeterminada cuando genera una clave en la aplicación web, pero puede agregarla si fuera útil. Los nombres de las claves no están guardados actualmente, por lo que puedes usar el nombre que quieras y la clave seguirá funcionando.
INST:V1 indica que esta clave utiliza el formato de clave instrumental versión 1.
La siguiente sección de 14 caracteres aleatorios es la parte "pública" de la clave, básicamente el nombre de usuario de la clave. Esto se muestra en el modal de clave API para identificar cada clave.
La parte después de los últimos dos puntos es la parte "privada" de la clave, básicamente la contraseña de la clave.

Las claves no se pueden reutilizar en diferentes proyectos, pero se pueden reutilizar en varias estaciones dentro de un proyecto. Necesitará al menos una clave para su proyecto de prueba y al menos una clave adicional para cada proyecto "real". ¡Asegúrese de que su código de integración utilice la clave correcta!

Permisos

Antes de hacer clic en "Agregar clave", puede elegir si la clave tendrá acceso de "lectura" o "escritura" (o ambos). “Leer” da acceso a la API de lectura de datos y “escribir” da acceso a API de Data Streams y la API de Image Streams.

Desactivar una clave

Para desactivar una clave, haga clic en el botón “DESACTIVAR” junto a la clave en el modo Claves API. Una vez que esto sucede, la clave ya no se podrá utilizar para realizar solicitudes de API. Aún puedes ver las claves desactivadas haciendo clic en el enlace "Mostrar claves desactivadas", pero no se pueden reactivar.

Errores de revisión

Las solicitudes de API que se autentican correctamente (es decir, que tienen un encabezado instrumental-api-key válido y no tienen una tasa limitada) pero que fallan en otra validación (por ejemplo, el cuerpo de la solicitud no es válido) serán accesibles temporalmente para su depuración a través del modo de clave API:

Al hacer clic en "N errores recientes" debajo del recuento de inspección de la clave, se mostrará una lista de las solicitudes fallidas más recientes. Puede hacer clic en cada solicitud o vista previa de respuesta para ver más detalles. Se mostrarán hasta 100 errores de los últimos 14 días. Si tiene más de 100 errores en los últimos 14 días y necesita recuperar datos de ellos, comuníquese con su administrador de cuentas para ver si podemos ayudarlo.

Recuperar el proyecto de una clave

Si tiene una clave API sin el prefijo del nombre del proyecto (es decir, comienza con INST:V1) y necesita averiguar a qué proyecto está asociado, puede realizar una solicitud GET. ahttps://api.instrumental.ai/api/v0/externalData/projectName con la clave en un instrumental-api-key encabezado. La respuesta contendrá solo el nombre del proyecto. Por ejemplo:

curl -XGET -H 'clave-api-instrumental: YOUR_API_KEY' https://api.instrumental.ai/api/v0/externalData/projectName

(Asegúrese de reemplazar YOUR_API_KEY con su clave API real. Necesitará la clave completa, no solo el identificador corto que se muestra en el modal de clave API).

¿Qué sigue?

Regrese a lapágina de soporte para encontrar documentación sobre el punto final API que le gustaría utilizar.