Descripción general y autenticación
Para qué sirve la API, la URL base, la cabecera de la clave y cómo encontrar el id de un departamento.
Descripción general
La API de Mira permite que tus propios sistemas envíen datos a Mira sin que nadie tenga que abrir la app. Una exportación nocturna de tu sistema de inventario, un script que extrae cifras de un almacén de datos, un formulario que recoge los resultados de una encuesta: cualquiera de ellos puede enviar un archivo CSV directamente a un departamento, donde se convierte en una tabla sobre la que la gente puede hacer preguntas.
También puedes usar la API para ver qué tablas tiene un departamento, consultar una en detalle y borrar la que ya no necesites.
| Si quieres | Usa |
|---|---|
| Añadir una tabla nueva o sustituir los datos de una existente | Importar datos |
| Ver la lista de tablas de un departamento, obtener una o borrarla | Tablas |
| Conocer los límites y qué significa cada error | Límites y errores |
URL base
Todas las direcciones de estas páginas empiezan por:
https://searchmira.com/api
Así, la dirección de importación, /v1.0/data/import, es https://searchmira.com/api/v1.0/data/import completa.
Autenticación
Cada petición lleva tu clave de API en una cabecera llamada X-API-Key:
X-API-Key: your_api_key_here
No hace falta nada más para identificarte. La clave le dice a Mira quién eres y en qué organización trabajas, así que nunca envías un id de organización.
Las claves se crean en Ajustes, en Acceso a la API. Esa página la ven los propietarios y los administradores. En Claves de API se explica cómo crear una.
Una petición sin clave, con una clave incorrecta o con una clave desactivada recibe un 401:
{ "Msg": "Invalid API Key" }
A qué llega una clave
Una clave actúa en nombre de la persona que la creó, dentro de una organización. Llega a los departamentos y las tablas a los que esa persona llega en la app, y a nada más. Si cambia su acceso, cambia también el de la clave.
Los departamentos y sus id
Mira guarda los datos en departamentos, y cada petición que trabaja con datos indica uno. La API llama ProjectID al id de un departamento. Es lo mismo.
Para encontrarlo, abre Acceso a la API en Ajustes. En Tus ID, elige un departamento y su Project ID aparece al lado. Haz clic en él para copiarlo. Al elegir un departamento, debajo aparecen sus tablas, cada una con su propio id (el Card ID), que necesitas para sustituir o borrar una tabla.
Respuestas
Las respuestas son JSON y casi todas incluyen un campo Msg. Dice OK cuando todo ha ido bien y, si no, explica qué ha fallado. En Límites y errores tienes la lista de códigos de estado.