WLI: Comprobación de nuestra API (consideraciones importantes)
Actualizado hoy
🔗Preparativos para la integración con Metricool
Este artículo debe consultarse si se activa un producto *White Label for Integrators* . Puedes obtener más información aquí.
A continuación, encontrarás un resumen sobre cómo consultar la documentación de nuestra API, algunas rutas de endpoints útiles para integradores y ejemplos de cómo usarlas.
... es importante tener en cuenta
Este artículo amplía la información de la documentación de API existente y explica cómo consultar endpoints de forma estática en lugar de dinámica. En el punto 1 de la lista de referencias que encontrarás más abajo se explica cómo consultar la API de forma dinámica.
En el segundo punto se explican algunas otras integraciones que pueden serte útiles para mejorar tus flujos de trabajo, además de la integración iframe/API.
En el punto 3 encontrarás una explicación básica de los conceptos generales de API. Al final del mismo artículo encontrarás nuestra documentación técnica. Si ya la has consultado y sabes cómo funciona, puedes acceder a ella en los puntos 4 y 5 de la lista.
Lista de referencias:
Cómo obtener un endpoint en Metricool para realizar llamadas a la API
Acceso a la API: exporta tus datos de Metricool a otras herramientas y automatiza tareas
La siguiente explicación usa el punto 4 como ejemplo base y utiliza Swagger. Si usas Postman, consulta el punto 5.
1. Abrir la documentación
Descarga el archivo
swagger.jsonoswagger.yamldel punto 4.Ve a editor.swagger > Abrir archivo > Importar archivo > y selecciona el archivo que has descargado en el paso anterior.
Deberías ver la documentación de la API, como se muestra en la siguiente captura de pantalla:
A partir de ahora, cada vez que se mencione nuestra documentación de API, se hará referencia a cualquiera de esos dos archivos abiertos desde Swagger.
Si trabajas con un cliente de IA, puedes usar este documento como contexto.
2. Rutas de endpoints útiles para el producto White Label Integration
Recuerda que puedes usar Ctrl+F para navegar fácilmente por la documentación. Para ello, te presentamos una lista de los endpoints más utilizados por los integradores:
Tabla A: Rutas de endpoints útiles para copiar y pegar
Endpoint | Descripción |
|---|---|
| Gestión de marcas (o perfiles). Aquí puedes añadir, eliminar, editar o consultar información sobre las marcas creadas para tus clientes finales |
| Para todo lo relacionado con el calendario. Esta es una de las secciones más completas de nuestra documentación en cuanto al número total de endpoints |
| Servicios y catálogos para recuperar toda la información disponible en nuestros paneles de analítica |
| Para crear informes personalizados y consultar métricas durante un periodo determinado |
| Métricas de la competencia |
| Todos los servicios relacionados con Inbox, incluidas las notas de la bandeja de entrada, los comentarios de publicaciones y las conversaciones |
| Diseñado para trabajar con el servicio de informes existente |
| Gestiona tus enlaces inteligentes |
| Paneles de rendimiento con información de campañas |
Recuerda que la URL base de todos los endpoints es: https://app.metricool.com/api
3. Ejemplo práctico de uso de nuestra API
El siguiente ejemplo muestra los requisitos mínimos para crear la integración Metricool White Label a partir de una configuración ideal. También explora los endpoints más consultados y sus detalles.
Ten en cuenta que este ejemplo es solo *ilustrativo y para pruebas*, y no debe considerarse una aplicación real.
WLI: Arquitectura de integración — enfoque de Customer Success
WLI: Endpoint para crear marcas — ejemplo de un proxy de backend personalizado
WLI: Endpoints de programación — ejemplo de un proxy de backend personalizado