En este artículo te explicamos dónde consultar la documentación oficial de las APIs de Mirakl y qué información encontrarás en cada ficha técnica.
- Para qué sirve la documentación de APIs
- Cómo acceder desde Mirakl
- Recursos oficiales de Mirakl
- Cómo buscar una API concreta
- Qué información incluye una ficha de API
- Antes de integrar por API
- Resumen
Las APIs de Mirakl permiten automatizar procesos entre tu sistema y la plataforma Marketplace.
Puedes usarlas para consultar o actualizar información relacionada con ofertas, pedidos, documentos, facturas u otros procesos disponibles en la documentación oficial.
Dentro de Mirakl, puedes acceder a la ayuda desde el icono de ayuda situado en la parte superior derecha de la pantalla.
- Accede a tu cuenta de vendedor en Mirakl.
- Selecciona el icono de ayuda de la parte superior derecha.
- Usa el buscador para localizar documentación relacionada con APIs.
- Abre el resultado que corresponda y revisa la información técnica.
Puedes consultar la documentación oficial desde estos recursos:
- Help Center de Mirakl: https://help.mirakl.com/
- Developer Portal de Mirakl: https://developer.mirakl.com/
- APIs Seller de Mirakl Marketplace: https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3
Si necesitas localizar una API concreta, usa el buscador del Help Center o del Developer Portal de Mirakl.
- Accede al Help Center o al Developer Portal.
- Introduce el proceso que quieres automatizar.
- Filtra o revisa los resultados relacionados con Seller APIs.
- Abre la API que corresponda y revisa la documentación completa.
Puedes buscar por términos como:
- Offers, para trabajar con ofertas.
- Orders, para trabajar con pedidos.
- Documents, para trabajar con documentos.
- Accounting, para información contable disponible por API.
- Invoices, para procesos relacionados con facturas cuando estén disponibles.
La información puede variar según la API, pero normalmente encontrarás datos como:
- Código o nombre de la API: identificador técnico de la operación, por ejemplo, pedidos, ofertas o documentos.
- Descripción: explicación de para qué sirve la API.
- Frecuencia de llamada: uso recomendado y límites de uso cuando estén definidos.
- Endpoint: ruta técnica que debe utilizar la integración.
- Método: tipo de llamada, como GET, POST, PUT o DELETE.
- Paginación: forma de recorrer resultados cuando la API devuelve muchos registros.
- Parámetros: filtros o campos que puedes enviar en la llamada.
- Campos de respuesta: estructura de datos que devuelve la API.
- Valores permitidos: estados, códigos o enumeraciones aceptadas.
- Ejemplos o esquemas: llamadas de ejemplo o estructuras de respuesta para facilitar la implementación.
- Notas técnicas: avisos sobre campos obsoletos, localización, permisos o alternativas recomendadas.
Imagen de ejemplo: la API mostrada puede no coincidir con la API que necesitas implementar. Úsala solo como referencia visual de cómo se presenta la documentación técnica.
Antes de desarrollar una integración, revisa estos puntos:
- Objetivo: define qué proceso quieres automatizar.
- Permisos: comprueba que tu usuario o integración tiene acceso a la información necesaria.
- Credenciales: gestiona claves o tokens de acceso de forma segura.
- Entorno: confirma si estás trabajando en prueba o producción.
- Volumen: revisa si la API recomienda exportaciones asíncronas para grandes volúmenes de datos.
- Errores: prepara una gestión adecuada de errores, reintentos y registros.
- La ayuda de Mirakl está en la parte superior derecha: accede desde el icono de ayuda de la plataforma.
- Consulta siempre documentación oficial: Help Center, Developer Portal e índice de APIs Seller.
- Cada API puede incluir información técnica distinta: endpoint, método, frecuencia, parámetros, paginación, respuestas y ejemplos.
- Necesitas apoyo técnico: las APIs requieren desarrollo, pruebas y gestión segura de credenciales.
- Evita usar una API concreta como índice general: busca siempre en el índice de APIs Seller o en el buscador oficial.