API Pines unitarios

API Pines unitarios

Documentación API de Generación de Pines Unitarios

Descripción General

Esta API permite la generación de pines de acceso para servicios de navegación. Los pines generados están vinculados a planes de navegación específicos y zonas determinadas.

Autenticación

Para utilizar la API, necesitarás una API key (x-api-key).

¿Cómo obtener tu API key?

  • Abre un ticket de soporte solicitando acceso a la API de pines
  • En el ticket, especifica:
  • ID de cliente
  • Motivo de uso
  • Contacto técnico responsable

    • Endpoint

    1. URL: /web/services/api_pines/pines.php
    2. Metodo: POST

    Headers requeridos

    1. x-api-key: tu_api_key Content-Type: application/json

    Estructura de la petición

    1. {
      "costumer_id": 123, // ID del cliente (requerido)
      "type": "general", // Tipo de pin (requerido)
      "field": "", // Campo adicional (requerido si type es diferente de general)
      "navigation_plan": "", // Plan de navegación (requerido)
      "zone": 123, // ID de la zona (requerido)
      "price": 0 // Precio del pin (opcional) "numeric_field" : false // opcional, si se quiere enviar el pin como numérico
      }

    Campo
    		Tipo
    Requerido
    Descripción
    costumer_id
    Number
    Sí
    Id del cliente, se puede encontrar en la sección de configuración de la plataforma
    type
    String
    Sí
    Tipo de pin ("general" o "phone")
    field
    		StringNo
    Este campo es requerido cuando el tipo de pin es phone, esto funciona para concatecar otros datos del usuario para que funcione como usuario y contraseña
    navigation_plan
    String
    Si
    nombre del plan de navegación, tal cual se creo en la plataforma
    zone
    		Number
    Si
    Id de la zona a la que se desea aplicar el plan de navegación, debe ser unicamente una zona
    price
    Number
    No
    precio del pin, valor por defecto = 0
    numeric_field
    Boolean
    No
    Si se quiere enviar el pin como numérico

    Respuestas

    1. {
      "message": "Pin created successfuly",
      "pin": "123abc",
      "field": "valor_campo"
      }

    Errores comunes

    1. Error de autenticación(401)
    1. {
      "message": "Not found"
      }
    1. Error de validación(400)
    1. {
      "message": "Not found"
      }
    2. {
      "message": "Zone is required"
      }
    3. {
      "message": "Navigation plan is required"
      }
    4. {
      "message": "Field is required"
      }

    Ejemplo de uso

    cURL
    PHP
    Python
    JavaScript
    cURL
    curl --location 'app.datawifi.co/easyfi/web/services/api_pines/pines.php' \ --header 'x-api-key: testPinesMasivos' \ --header 'Content-Type: application/json' \ --data '{ "costumer_id" : 123, "type": "general", "navigation_plan": "nombre_plan", "zone": 123, "numeric_field": true }'
    PHP
    <?php

    $curl = curl_init();

    curl_setopt_array($curl, array(
    CURLOPT_URL => 'app.datawifi.co/easyfi/web/services/api_pines/pines.php',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => '',
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 0,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS =>'{
    "costumer_id" : 123,
    "type": "general",
    "navigation_plan": "nombre_plan",
    "zone": 123,
    "numeric_field": true
    }',
    CURLOPT_HTTPHEADER => array(
    'x-api-key: testPinesMasivos',
    'Content-Type: application/json'
    ),
    ));

    $response = curl_exec($curl);

    curl_close($curl);
    echo $response;

    Python
    import requests
    import json

    url = "qa.datawifi.co/easyfi/web/services/api_pines/pines.php"

    payload = json.dumps({
    "costumer_id": 123,
    "type": "general",
    "navigation_plan": "nombre_plan",
    "zone": 123,
    "numeric_field": True
    })
    headers = {
    'x-api-key': 'testPinesMasivos',
    'Content-Type': 'application/json'
    }

    response = requests.request("POST", url, headers=headers, data=payload)

    print(response.text)

    JavaScript
    const myHeaders = new Headers();
    myHeaders.append("x-api-key", "testPinesMasivos");
    myHeaders.append("Content-Type", "application/json");

    const raw = JSON.stringify({
    "costumer_id": 123,
    "type": "general",
    "navigation_plan": "nombre_plan",
    "zone": 123,
    "numeric_field": true
    });

    const requestOptions = {
    method: "POST",
    headers: myHeaders,
    body: raw,
    redirect: "follow"
    };

    fetch("qa.datawifi.co/easyfi/web/services/api_pines/pines.php", requestOptions)
    .then((response) => response.text())
    .then((result) => console.log(result))
    .catch((error) => console.error(error));
     













        • Related Articles

        • API Pines Masivos

          Documentación API de Generación de Pines Masivos Descripción General Esta API permite la generación de pines de acceso para servicios de navegación. Los pines generados están vinculados a planes de navegación específicos y zonas determinadas. ...

        • API

          ¿Qué es el módulo API? Sirve para integrarse con sistemas de la información, realizar validación, preguntado datos, verificando, relacionarlos con las bases de datos por medio de una función de llamada. ¿Cómo visualizar el módulo API? 1. Para llegar ...

        • API - MANUAL

          Objetivo MARKETING WIFI como solución para la comunicación, marketing y autenticación en zonas WiFi e independiente de la arquitectura implementada en sitio (APs, controladoras, etc.) para el funcionamiento de las Zonas WiFi, cuenta con un API para ...

        • MANUAL CONFIGURACIÓN DE PINES

          MANUAL PARA CONFIGURACIÓN DE PINES REQUISITOS PREVIOS Haber generado anteriormente los planes de navegación que se usarán en los pines. Tener generados las zonas donde se van a asignar los pines. PROCESO DE CONFIGURACIÓN En la parte superior de la ...

        • CONFIGURACIÓN DE VOUCHERS (PINES)

          MANUAL DE CONFIGURACIÓN DE VOUCHERS (PINES) RECOMENDACIONES PREVIAS El módulo de pines facilita la asignación de diversos planes de navegación de acuerdo con el código establecido por el administrador de la plataforma. Se aconseja anticipadamente la ...