MyMSB API v0.6.0.25

0. Introducción

Las llamadas disponibles en MyMSB se encuentran listadas a continuación. Puedes descargar la librería mymsb.class.php y descargarte el ejemplo como referencia para tus llamadas.

Los parámetros deben ser enviados a través de un array con pares de variable => valor y se envían a la API.

La API devolverá la información en json

descarga la librería mymsb.class.php

                        
/**
 * Conexión a la API de MyMSB
 * El usuario se encargará de redefinir las funciones que requiera, esta versión del fichero se ha realizado para la versión 0.3.2.2 en Mayo/2021 de forma
 * que probablemente en el momento en el que se utilice esta clase, algunas de estas funciones podrían no estar ya disponibles, así como podría haber nuevas
 * funciones que no se encuentren aquí.
 * Las funciones publicadas y actualizadas se encontrarán para su consulta en https://api.mymsb.es
 */

class MyMSBCallAPI {

    function __construct(){
    }

    /** CLIENTES **/
    
    /**
     * Añade un cliente
     */
    public function addClient($data){
        $request = "addClient";
        return $this->callAPI($request, $data);
    }

    /**
     * Modifica un cliente
     */
    public function updateClient($data){
        $request = "updateClient";
        return $this->callAPI($request, $data);
    }

    /**
     * Elimina un cliente
     */
    public function deleteClient($data){
        $request = "deleteClient";
        return $this->callAPI($request, $data);
    }


    /**
     * Devuelve el nº de leads registrados
     */
    public function getCountLead($data) {
        $request = "getCountLead";
        return $this->callAPI($request, $data);
    }

    /**
     * Devuelve el nº de clientes registrados
     */
    public function getCountClient($data) {
        $request = "getCountClient";
        return $this->callAPI($request, $data);
    }

    /**
     * Devuelve el nº total de clientes + leads registrados
     */
    public function getCountClientAll($data) {
        $request = "getCountClientAll";
        return $this->callAPI($request, $data);
    }

    /**
     * Devuelve los datos de un cliente
     */
    public function getClient($data) {
        $request = "getClient";
        return $this->callAPI($request, $data);
    }


    /** SUSCRIPTORES **/
    
    /**
     * Añade un suscriptor
     */
    public function addSubscriber($data){
        $request = "addSubscriber";
        return $this->callAPI($request, $data);
    }

    /**
     * Modifica un suscriptor
     */
    public function updateSubscriber($data){
        $request = "updateSubscriber";
        return $this->callAPI($request, $data);
    }

    /**
     * Elimina un suscriptor
     */
    public function deleteSubscriber($data){
        $request = "deleteSubscriber";
        return $this->callAPI($request, $data);
    }


    /**
     * Devuelve el nº de suscriptores
     */
    public function getCountSubscriber($data) {
        $request = "getCountSubscriber";
        return $this->callAPI($request, $data);
    }

    /**
     * Devuelve los datos de un suscriptor
     */
    public function getSubscriber($data) {
        $request = "getSubscriber";
        return $this->callAPI($request, $data);
    }

    

    /** CATEGORÍAS **/

    public function addCategory($data) {
        $request = "addCategory";
        return $this->callAPI($request, $data);
    }

    public function updateCategory($data) {
        $request = "updateCategory";
        return $this->callAPI($request, $data);
    }

    public function deleteCategory($data) {
        $request = "deleteCategory";
        return $this->callAPI($request, $data);
    }

    public function getCountCategory($data) {
        $request = "getCountCategory";
        return $this->callAPI($request, $data);
    }

    public function getCategory($data) {
        $request = "getCategory";
        return $this->callAPI($request, $data);
    }

    /** PRODUCTOS **/

    public function addProduct($data) {
        $request = "addProduct";
        return $this->callAPI($request, $data);
    }

    public function updateProduct($data) {
        $request = "updateProduct";
        return $this->callAPI($request, $data);
    }

    public function deleteProduct($data) {
        $request = "deleteProduct";
        return $this->callAPI($request, $data);
    }

    public function getCountProduct($data) {
        $request = "getCountProduct";
        return $this->callAPI($request, $data);
    }

    /** FEED MERCHANT CENTER **/

    public function createFeed($data) {
        $request = "createFeed";
        return $this->callAPI($request, $data);
    }

    /** VENTAS **/

    /**
     * Añade una compra
     * Campos necesarios en la https://api.mymsb.es
     */
    public function addPurchase($data){
        $request = "addPurchase";
        return $this->callAPI($request, $data);
    }

    /**
     * Modifica una compra
     * Campos necesarios en la https://api.mymsb.es
     */
    public function updatePurchase($data){
        $request = "updatePurchase";
        return $this->callAPI($request, $data);
    }

    /**
     * Modifica un estado de una compra
     * Campos necesarios en la https://api.mymsb.es
     */
    public function updatePurchaseStatus($data){
        $request = "updatePurchaseStatus";
        return $this->callAPI($request, $data);
    }

    /**
     * Elimina una compra
     * Campos necesarios en la https://api.mymsb.es
     */
    public function deletePurchase($data){
        $request = "deletePurchase";
        return $this->callAPI($request, $data);
    }

    /**
     * Devuelve el nº total de compras
     * Campos necesarios en la https://api.mymsb.es
     */
    public function getCountPurchaseAll($data) {
        $request = "getCountPurchaseAll";
        return $this->callAPI($request, $data);
    }


    // Realiza la llamada a la API de MyMSB con los datos proporcionados
    private function callAPI($request, $data = array()){

        $url = "https://api.mymsb.es/".$request."/";

        // create a new cURL resource
        $ch = curl_init();

        // set URL and other appropriate options
        curl_setopt($ch, CURLOPT_URL, $url);

        // Empezamos a construir los parámetros que se van a enviar
        $pf = '';

        if ($postarray !== null) {

            // Construimos la cadena completa de parámetros
            curl_setopt($ch, CURLOPT_POST, TRUE);
            foreach ($postarray AS $f=>$v) {
                if (is_array($v))
                    $pf .= '&'.$f.'='.json_encode($v);
                else
                    $pf .= '&'.$f.'='.$v;
            }
        }
        curl_setopt($ch, CURLOPT_POSTFIELDS, $pf);
        curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

        // grab URL and pass it to the browser
        $response = curl_exec($ch);

        // close cURL resource, and free up system resources
        curl_close($ch);

        $json = json_decode($response,true);

        if(is_array($json))
            return $json;
        else
            return $response;
    }
}
                        
                    

ver ejemplo

                        

/**
 * Ejemplo de llamada API a un alta de cliente
 */

include_once 'mymsb.class.php';

$ad = new MyMSBCallAPI();

$rest = null;

$data = array(
  'token' => '',
  'id' => 6,
  'nombre' => 'Alex',
  'apellidos' => 'Ponte',
  'mail' => 'prueba@estudioseijo.com',
  'telefono' => '600123123'
);

$rest = $ad->addClient($data);

if (is_array($rest)) { 
 echo '<pre>';
 print_r($rest);
 echo '</pre>'; 
}
else
echo 'No se ha devuelto nada';                    

1. Clientes

El concepto de cliente representa cualquier estadio de usuario de la plataforma. Según haya o no comprado será un lead o un cliente.

addClient

Añade un nuevo cliente como lead

updateClient

Actualiza un cliente/lead existente. En caso de que la opción createIfNotExists esté a true, si el cliente no existe, lo crea.

deleteClient

Elimina un cliente/lead existente

La función devuelve el id de cliente/lead eliminado

getCountLead / getCountClient / getCountClientAll

• getCountLead devuelve el número de clientes que no han hecho ninguna compra
• getCountClient devuelve el número de clientes que han comprado (clientes reales)
• getCountClientAll devuelve el número total de clientes + leads registrados

getClient

Devuelve la información de un cliente

2. Suscriptores

El concepto de suscriptor representa un usuario que se ha registrado en la newsletter

addSubscriber

Añade un nuevo suscriptor

updateSubscriber

Actualiza un suscriptor existente. En caso de que la opción createIfNotExists esté a true, si el suscriptor no existe, lo crea.

deleteSubscriber

Elimina un suscriptor existente

La función devuelve el id de suscriptor eliminado

getCountSubscriber

Devuelve el nº total de suscriptores

getSubscriber

Devuelve la información de un suscriptor

3. Categorías de producto

El concepto de categoría de productos representa la jerarquía en la que se organizan los productos. Los productos pueden vincularse a una familia y las familias pueden organizarse en una estructura de árbol

addCategory

Añade una nueva categoría de producto

La función devuelve el id de categoría de producto creado

updateCategory

Actualiza una categoría de producto existente. En caso de que la opción createIfNotExists esté a true, si la categoría no existe, la crea.

La función devuelve el id de categoría de producto modificado

deleteCategory

Elimina una categoría de producto existente siempre que no tenga categorías hijas. Si tiene artículos, se borra igualmente (sus artículos dejan de salir en los feeds) y queda un aviso en el registro.

La función devuelve el id de categoría de producto eliminado

getCountCategory

Devuelve el número de categorías de productos almacenados en el sistema

getCategory

Devuelve información de una categoría

4. Productos

El concepto de productos representa cualquier producto o servicio susceptible de comprar, alquilar, reservar. Es cualquier elemento que se quiera vincular a ventas.

addProduct

Añade un nuevo producto y opcionalmente una nueva marca y/o una nueva categoría

La función devuelve el id de producto creado, así como el nuevo id de marca y categoría si se han creado

updateProduct

Actualiza un producto existente y opcionalmente una nueva marca y/o una nueva categoría. Si la opción createIfNotExists está a true y el producto no existe, lo crea.

La función devuelve el id de producto modificado, así como el nuevo id de marca y categoría si se han creado. No modifica marcas ni categorías, solamente las crea si es necesario.

deleteProduct

Elimina un producto existente siempre y cuando no se haya vinculado previamente a alguna venta

La función devuelve el id de producto eliminado

getCountProduct

Devuelve el número de productos almacenados en el sistema

5. Ventas

Registro de ventas (para proyectos de comercio electrónico o similar), o para controlar cualquier tipo de captación de registro o similar que se quiera controlar.

addPurchase

Añade una nueva venta

Salidas

• created_id: Id de myMSB de la venta modificada
• your_id: Id recibido de la venta
• client_purchases: Nº de ventas totales del cliente (solamente si updateClientPurchases es true y si ha cambiado el nº de ventas del cliente)

updatePurchase

Actualiza una venta existente. Si la opción createIfNotExists está a true y la venta no existe, se crea

Salidas

• updated_id: Id de myMSB de la venta modificada
• your_id: Id recibido de la venta
• client_purchases: Nº de ventas totales del cliente (solamente si updateClientPurchases es true)

updatePurchaseStatus

Actualiza el estado de una venta existente

Salidas

• updated_id: Id de myMSB de la venta modificada
• your_id: Id recibido de la venta
• client_purchases: Nº de ventas totales del cliente (solamente si updateClientPurchases es true)

deletePurchase

Elimina una venta existente

Salidas

• deleted_id: Id de myMSB de la venta eliminada
• your_id: Id recibido de la venta
• client_purchases: Nº de ventas totales del cliente (solamente si updateClientPurchases es true)

getCountPurchaseAll

La función devuelve el nº total de ventas

6. Formularios de contacto

Registra formularios cubiertos a través de la web

addForm

Añade un nuevo formulario

updateForm

Actualiza un formulario existente, buscado por el id que se envió en addForm. Si no existe, devuelve un error (no atiende la opción createIfNotExists).

deleteForm

Elimina un formulario existente

La función devuelve el id de formulario eliminado

getCountForm

Devuelve el nº total de formularios no borrados

getForm

Devuelve la información de un formulario

7. APIs para recuperación de datos de constantes

Formas de pago

Formas de pago aceptadas por MyMSB

getPayments

Recupera las formas de pago disponibles. Actualmente estas son las formas de pago aceptadas

Se usa en:

• addPurchase
• updatePurchase

Impuestos

Impuestos aceptados por MyMSB

getTaxes (no disponible por la API: la tabla es solo de consulta)

Recupera los impuestos disponibles. Se aceptan los siguientes

Países

Lista de países del mundo

getCountries

Recupera el listado de países. Se pueden consultar en la siguiente tabla

Se usa en:

• addCliente
• updateCliente

CCAA

Sólo válido para España. Lista de comunidades autónomas de España

getRegions

Recupera el listado de comunidades autónomas de España. Se pueden consultar en la siguiente tabla

Provincias

Sólo válido para España. Lista de provincias de España

getProvinces

Recupera el listado de provincias de España. Se pueden consultar en la siguiente tabla

Se usa en:

• addCliente
• updateCliente

¿Cómo nos conoció?

Canales de entrada / cómo nos conoció

getChannels

Recupera el listado de canales disponibles. Se pueden consultar en la siguiente tabla

Perfiles de cliente

Categorías del cliente

getClientCategories

Recupera el listado de perfiles de cliente disponibles. Se pueden consultar en la siguiente tabla

Se usa en:

• addCliente
• updateCliente

Estados de los pedidos

Lista de estados de pedido compatibles con MyMSB

getOrdersStatus

Recupera la lista de estados de la venta disponibles.

Se usa en:

• addPurchase
• updatePurchase
• updatePurchaseStatus

Formas de envío

Lista de formas de envío compatibles con MyMSB

getShippingMethods

Recupera la lista de formas de envío disponibles.

Se usa en:

• addPurchase
• updatePurchase

Compañías de transporte

Lista de compañías de transporte

getTransportCompanies

Recupera la lista de compañías de transporte.

Se usa en:

• addPurchase
• updatePurchase

Cupones descuento

Lista de tipos de cupones descuento

getCouponCategories

Recupera la lista de tipos de cupones descuento.

Se usa en:

• addPurchase
• updatePurchase

Formularios

Datos relacionados con la gestión de formularios

getFormCategories

Tipos de categorías de formularios compatibles con myMSB

Se usa en:

• addForm
• updateForm

Pipeline

Ahora cada proyecto cuenta con su propio pipeline de estados que se crean dinámicamente y serán asociados según su proyecto relacionado.

Se usa en:

• addForm
• updateForm

Tipos de producto

Categorías del producto

getProductCategories

Recupera el listado de tpos de producto disponibles. Se pueden consultar en la siguiente tabla

Se usa en:

• addproductoLinea
• updateProductoLinea

8. Estadísticas de Google

Visitas de Google Analytics 4 y búsquedas de Google Search Console de la web del proyecto. MyMSB las descarga de Google cada noche, así que la tienda no necesita credenciales de Google ni gasta su cuota: las pide aquí.

Lo común a todas

• Llamada por POST a https://api.mymsb.es/<acción>/ (con la barra final), con el campo token del proyecto.
• El proyecto tiene que tener activada la API y configurada la fuente: la propiedad de GA4 para las acciones de Analytics, y la propiedad de Search Console para getSearchConsoleData.
• Si va bien, la respuesta es:

  {"success": true, "project_id": 12, "date_range": {"from": "2026-09-01", "to": "2026-09-30"}, "group": "dia", "data": [ … ]}

  group sólo aparece en las acciones que agrupan por día o mes. data va ordenada como se indica en cada acción.
• Si algo falla en lo que se envía, la respuesta es {"error": "texto"}. Los textos posibles son:
  • El token es requerido
  • El token no es válido
  • La API no está habilitada para este proyecto
  • El proyecto no tiene Google Analytics configurado
  • El proyecto no tiene Search Console configurado
  • Las fechas deben tener el formato YYYY-MM-DD
  • Hay que enviar desde y hasta, o ninguna de las dos
  • desde no puede ser posterior a hasta
  • El rango máximo es de 25 meses
  • agrupar debe ser dia o mes
  • limite debe estar entre 1 y 1000
  • dimension debe ser consulta, pagina o fecha

Fechas

• desde y hasta van sólo en formato YYYY-MM-DD (aquí no valen los otros formatos de datetime), y los dos días van incluidos.
• Se mandan los dos o ninguno. Sin ninguno, el rango es de los últimos 30 días hasta ayer.
• Como mucho, 25 meses entre desde y hasta.
• Los días que todavía no se han descargado no aparecen en data; los días sin visitas salen con 0. GA4 tarda hasta 48 horas en cerrar un día, así que MyMSB vuelve a pedir cada noche los tres últimos: el dato de ayer puede subir un poco al día siguiente.

getAnalyticsData

Visitas de la web por día o por mes.

• data va de más antiguo a más reciente.
• Al agrupar por mes, las visitas, los nuevos y las páginas son la suma de los días. La duración y el rebote son medias ponderadas por visitas.
• Visitantes por mes: no se pueden sumar los de cada día, porque quien entra varios días contaría varias veces. Si el mes entero está en el rango (el mes en curso, hasta ayer) y MyMSB tiene todos sus días, se da el dato mensual de Google y visitantesunicos_exacto es true. Si no, es la suma de los días y sale false.
• Rebote: es el de GA4, es decir, 1 − el porcentaje de visitas con interacción. Sale null en los días antiguos guardados antes de que MyMSB lo descargara bien, y en los meses que tienen alguno de esos días.
• Sin desde, hasta ni agrupar, la acción responde con el formato antiguo, por compatibilidad: los dos últimos días, admitiendo también el token por GET (?project=).

ver ejemplo de respuesta

POST https://api.mymsb.es/getAnalyticsData/
token=…&desde=2026-08-01&hasta=2026-09-30&agrupar=mes

{"success": true, "project_id": 12,
 "date_range": {"from": "2026-08-01", "to": "2026-09-30"}, "group": "mes",
 "data": [
   {"periodo": "2026-08", "visitas": 2100, "visitantesunicos": 950, "visitantesunicos_exacto": true,
    "visitasnuevas": 720, "duracion": 241.5, "rebote": 0.38, "paginas": 11800, "paginasvisita": 5.62},
   {"periodo": "2026-09", "visitas": 1900, "visitantesunicos": 800, "visitantesunicos_exacto": true,
    "visitasnuevas": 640, "duracion": 262.1, "rebote": 0.36, "paginas": 12100, "paginasvisita": 6.37}
 ]}

getAnalyticsChannels

Lo mismo que getAnalyticsData, separado por el canal por el que llegó cada visita.

• data va de más antiguo a más reciente y, dentro de cada periodo, de más a menos visitas. Sólo salen los canales con alguna visita.
• Las visitas de todos los canales de un periodo suman las de getAnalyticsData en ese periodo.

ver ejemplo de respuesta

{"success": true, "project_id": 12,
 "date_range": {"from": "2026-09-01", "to": "2026-09-30"}, "group": "mes",
 "data": [
   {"periodo": "2026-09", "canal": "Organic Search", "visitas": 600, "visitantesunicos": 450,
    "visitantesunicos_exacto": false, "visitasnuevas": 210, "duracion": 330.2, "rebote": 0.14,
    "paginas": 3900, "paginasvisita": 6.5},
   {"periodo": "2026-09", "canal": "Direct", "visitas": 210, … }
 ]}

getAnalyticsPages

Visitas de cada página en un rango, de más a menos. Es la que sirve para el ranking de artículos: con ruta se filtran, por ejemplo, las fichas de producto.

• Cada noche se guardan las 1.000 páginas con más visitas de cada día. En webs pequeñas son todas; en una web muy grande, las de muy pocas visitas pueden faltar.
• La ruta no lleva los parámetros (?…), así que las variantes de una misma página se juntan solas.

ver ejemplo de respuesta

POST https://api.mymsb.es/getAnalyticsPages/
token=…&desde=2026-09-01&hasta=2026-09-30&ruta=/producto/&limite=3

{"success": true, "project_id": 12,
 "date_range": {"from": "2026-09-01", "to": "2026-09-30"},
 "data": [
   {"ruta": "/producto/queso-ahumado", "visitas": 120, "paginas": 168},
   {"ruta": "/producto/queso-tierno", "visitas": 95, "paginas": 130},
   {"ruta": "/producto/yogur-natural", "visitas": 61, "paginas": 77}
 ]}

getSearchConsoleData

Cómo aparece la web en las búsquedas de Google: clics, impresiones, CTR y posición, por fecha, por búsqueda o por página.

• La respuesta lleva además "dimension". Lleva group sólo con dimension = fecha.
• Con fecha, data va de más antiguo a más reciente. Con consulta o pagina, de más a menos clics y, si empatan, de más a menos impresiones.
• Google tarda unos 3 días en cerrar los datos: los últimos días todavía no aparecen. Un día que falta no significa «cero búsquedas».
• Google no da las búsquedas poco frecuentes, así que la suma por consulta es menor que el total por fecha. Por página cuenta una impresión por cada página que sale en un resultado, así que esas cifras tampoco tienen por qué cuadrar con el total.
• Google guarda 16 meses de datos. MyMSB los conserva desde que empieza a descargarlos.

ver ejemplo de respuesta

POST https://api.mymsb.es/getSearchConsoleData/
token=…&desde=2026-09-01&hasta=2026-09-30&dimension=consulta&limite=2

{"success": true, "project_id": 12,
 "date_range": {"from": "2026-09-01", "to": "2026-09-30"}, "dimension": "consulta",
 "data": [
   {"consulta": "queso de tetilla", "clics": 120, "impresiones": 800, "ctr": 0.15, "posicion": 3.4},
   {"consulta": "comprar queso online", "clics": 40, "impresiones": 900, "ctr": 0.0444, "posicion": 9.8}
 ]}

9. Búsquedas, reseñas, feeds y widgets

addSearch

Guarda una búsqueda hecha en el buscador de la web.

getReviews

Devuelve las reseñas de Google activas del proyecto, que MyMSB descarga cada noche. Solo necesita el campo token.

createFeed

Regenera los feeds de productos del proyecto para Google Merchant Center (XML) y Facebook (CSV). Solo necesita el campo token. Devuelve las URL de los dos ficheros en url y urlfb.

whatsappWidget, cookieWidget y cookieConsent

Las usan los scripts remotos del widget de WhatsApp y del banner de cookies, que se cargan en la web con el token del proyecto. No hace falta llamarlas a mano:

• whatsappWidget: configuración y horarios del widget de WhatsApp (?project=<token>).
• cookieWidget: textos y colores del banner de cookies (?project=<token>).
• cookieConsent: suma una decisión del visitante en el banner (?project=<token>&a=accept_all|reject_all|accept_custom).

10. Ayudas para tipos de datos

Datetime

Los campos de tipo date o datetime aceptan los siguientes formatos:

• yyyymmdd
• yyyy-mm-dd
• yyyy-mm-dd hh:mm:ss
• yyyy/mm/dd
• yyyy/mm/dd hh:mm:ss
• dd/mm/aaaa
• dd/mm/aaaa hh:mm:ss
• dd-mm-aaaa
• dd-mm-aaaa hh:mm:ss