तकनीकी दस्तावेज़ीकरण

विजेट एकीकरण

स्वचालित लोडिंग (Plug & Play)

बिना अतिरिक्त कॉन्फ़िगरेशन के बुनियादी कार्यान्वयन। विजेट डिफ़ॉल्ट मानों के साथ तुरंत लोड होता है।

अलग CSS लिंक की ज़रूरत नहीं: स्क्रिप्ट स्वचालित रूप से स्टाइलशीट जोड़ती है (`.js` जैसा ही आधार पथ)। वैकल्पिक रूप से `` में `` रखकर CSS और JS समानांतर डाउनलोड कर सकते हैं।

<script defer src="https://api.addaw.org/addaw-wba11y.min.js"></script>

API के माध्यम से आरंभीकरण (अनुशंसित)

JavaScript से विलंब और कस्टम विज़ुअल कॉन्फ़िगरेशन परिभाषित करने की अनुमति देता है।

<script defer src="https://api.addaw.org/addaw-wba11y.min.js"></script>
<script defer>
Addaw.init({
  delay: 5000,
  position: 'left',
  dark_mode: '1',
  lang: 'es',
  logo_url: 'https://yoursite.com/logo.png',
  logo_link: 'https://yoursite.com'
});
</script>

आरंभीकरण पैरामीटर

Initialization parameters reference

पैरामीटर	प्रकार	डिफ़ॉल्ट	विवरण
delay	Number	0	विलंबित लोडिंग के लिए ms में समय।
position	String	'right'	बटन की स्थिति: left या right।
dark_mode	String / Bool	'0'	डार्क मोड में शुरू करने के लिए 1 (यदि कोई मेमोरी नहीं है)।
lang	String	'auto'	ISO भाषा कोड (es, en, fr...)।
autoInit	Boolean	true	यदि false है, तो विजेट मैन्युअल रूप से कॉल किए जाने की प्रतीक्षा करता है।
logo_url	URL	ADDAW logo	विजेट फुटर के लिए कस्टम छवि।
logo_link	URL	https://addaw.org/es	कस्टम लोगो पर क्लिक का गंतव्य।

नियंत्रण विधियाँ (सार्वजनिक API)

विजेट लोड होने के बाद उसके साथ इंटरैक्ट करने के लिए कंसोल या अपनी स्क्रिप्ट से इन कमांड का उपयोग करें।

Addaw.initialized — जाँचता है कि विजेट सक्रिय है या नहीं।

if (Addaw.initialized) {
  console.log('Widget is active');
}

Addaw.destroy() — साइट से विजेट को पूरी तरह हटाता है।

Addaw.destroy();

Addaw.init({...}) — नई कॉन्फ़िगरेशन के साथ फिर से आरंभ करता है।

Addaw.init({
  position: 'left',
  dark_mode: '1',
  lang: 'en'
});

कॉन्फ़िगरेशन पदानुक्रम

विजेट सेटिंग्स लागू करने के लिए एक सख्त प्राथमिकता तर्क का पालन करता है:

उन्नत मैनुअल नियंत्रण

उन अनुप्रयोगों के लिए जिन्हें ऑन-डिमांड स्टार्ट की आवश्यकता होती है (उदाहरण के लिए, किसी विशिष्ट बटन को दबाने के बाद):

<script>
window.AddawConfig = { autoInit: false };
</script>
<script defer src="https://api.addaw.org/addaw-wba11y.min.js"></script>
<script defer>
document.addEventListener('DOMContentLoaded', function() {
  Addaw.init({
    position: 'right',
    lang: 'es'
  });
});
</script>

डोमेन प्रबंधन API

कर्मचारियों को अपने खाते से जुड़े डोमेन प्रबंधित करने और विजेट की दिखावट व व्यवहार अनुकूलित करने के लिए REST API (रंग पैलेट व Addaw.init-समकक्ष पैरामीटर)।

Endpoints disponibles (API empleado)

Employee API endpoints

Metodo	Endpoint	Descripcion
POST	/webService/ApiEmpleadoLogin	Autentica y devuelve access_token tipo Bearer.
GET	/webService/ApiEmpleadoPing	Comprueba validez del token y estado operativo.
POST	/webService/ApiEmpleadoDominioAlta	Alta de dominio (idempotente, con control de cuota/plan activo).
POST	/webService/ApiEmpleadoDominioBaja	Baja logica del dominio (marca activo=0).
GET	/webService/ApiEmpleadoMisDominios	Lista dominios activos con su configuracion efectiva.
GET	/webService/ApiEmpleadoColoresDisponibles	Lista paletas de color disponibles.
POST	/webService/ApiEmpleadoPersonalizarDominio	Guarda color y opciones del widget por dominio.

Quickstart backend (flujo recomendado)

1. Autentica con ApiEmpleadoLogin y guarda access_token.
2. Da de alta el dominio con ApiEmpleadoDominioAlta.
3. Consulta paletas con ApiEmpleadoColoresDisponibles.
4. Aplica configuracion con ApiEmpleadoPersonalizarDominio.
5. Valida el resultado con ApiEmpleadoMisDominios.

# Quickstart con curl (requiere jq)
TOKEN=$(curl -s -X POST "https://panel.addaw.org/webService/ApiEmpleadoLogin" \
  -H "Content-Type: application/json" \
  -d '{"correo":"tu_correo@ejemplo.com","pass":"tu_password"}' | jq -r '.access_token')

curl -s "https://panel.addaw.org/webService/ApiEmpleadoMisDominios" \
  -H "Authorization: Bearer ${TOKEN}"

प्रमाणीकरण

सभी अनुरोधों (login को छोड़कर) के लिए Authorization हेडर में Bearer टोकन आवश्यक है।

$ch = curl_init('https://panel.addaw.org/webService/ApiEmpleadoLogin');
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'Content-Type: application/json',
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode([
    'correo' => 'tu_correo@ejemplo.com',
    'pass'   => 'tu_password',
]));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = json_decode(curl_exec($ch), true);
curl_close($ch);

$token = $response['access_token'];

Ping autenticado

Endpoint recomendado para verificar token y conectividad antes de operaciones de dominio.

curl -X GET "https://panel.addaw.org/webService/ApiEmpleadoPing" \
  -H "Authorization: Bearer $TOKEN"

Respuesta esperada: ok, datos del empleado y server_time.

एक डोमेन पंजीकृत करें

आपके खाते से जुड़ा एक नया डोमेन पंजीकृत करता है। ऑपरेशन आइडेम्पोटेंट है: यदि डोमेन पहले से मौजूद है, तो इसे डुप्लिकेट नहीं किया जाता।

$ch = curl_init('https://panel.addaw.org/webService/ApiEmpleadoDominioAlta');
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'Authorization: Bearer ' . $token,
    'Content-Type: application/json',
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode(['dominio' => 'www.example.com']));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = json_decode(curl_exec($ch), true);
curl_close($ch);

एक डोमेन निष्क्रिय करें

एक डोमेन को निष्क्रिय करता है। इसे हटाया नहीं जाता, इसे निष्क्रिय के रूप में चिह्नित किया जाता है।

$ch = curl_init('https://panel.addaw.org/webService/ApiEmpleadoDominioBaja');
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'Authorization: Bearer ' . $token,
    'Content-Type: application/json',
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode(['dominio' => 'www.example.com']));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = json_decode(curl_exec($ch), true);
curl_close($ch);

मेरे डोमेन प्राप्त करें

आपके खाते से जुड़े सक्रिय डोमेन की सूची लौटाता है।

$ch = curl_init('https://panel.addaw.org/webService/ApiEmpleadoMisDominios');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'Authorization: Bearer ' . $token,
]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = json_decode(curl_exec($ch), true);
curl_close($ch);

उपलब्ध रंगों की सूची

विजेट को अनुकूलित करने के लिए उपलब्ध रंग पैलेट के नाम और आईडी लौटाता है।

$ch = curl_init('https://panel.addaw.org/webService/ApiEmpleadoColoresDisponibles');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'Authorization: Bearer ' . $token,
]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = json_decode(curl_exec($ch), true);
curl_close($ch);

एक डोमेन अनुकूलित करें

किसी डोमेन के लिए विजेट सेटिंग सहेजता है: रंग पैलेट और वैकल्पिक रूप से Addaw.init जैसे ही पैरामीटर (भाषा, डार्क मोड, स्थिति, ऑटो-स्टार्ट, लोगो, विलंब और मोडल फ़ोकस)। पहले अनुरोध में `color` पैलेट आईडी आवश्यक है; बाद में इसे छोड़कर सहेजे रंग रखे जा सकते हैं या केवल कुछ फ़ील्ड अपडेट किए जा सकते हैं। सहेजी गई वैल्यू हटाने के लिए कुंजी `null` भेजें।

JSON बॉडी पैरामीटर

`dominio` के अलावा निम्न फ़ील्ड शामिल कर सकते हैं। नाम विजेट API से मेल खाते हैं (`autoInit` और `focusOnContent`; `auto_init` और `focus_on_content` भी स्वीकार)।

JSON body parameters for domain customization

पैरामीटर	प्रकार	विवरण
color	integer	उपलब्ध रंगों की सूची से पैलेट आईडी। पहली बार डोमेन कॉन्फ़िगर करते समय आवश्यक; बाद में छोड़ने पर सहेजे रंग बने रहते हैं।
lang	string | null	दो अक्षरों का ISO 639-1 कोड (जैसे `es`) या डिफ़ॉल्ट के लिए `null`।
dark_mode	boolean | null	`true` / `false`, `1` / `0` या `null` (प्रारंभिक डार्क मोड; ब्राउज़र में सहेजी प्राथमिकताओं का सम्मान)।
position	string | null	`left`, `right` या `null`।
autoInit / auto_init	boolean | null	`true` / `false`, `1` / `0` या `null` (स्क्रिप्ट लोड पर ऑटो-स्टार्ट)।
logo_url	string | null	फ़ुटर लोगो URL (http, https, पूर्ण पथ या सापेक्ष `./`) या `null`।
logo_link	string | null	लोगो क्लिक पर लक्ष्य URL या `null`।
delay	integer | null	शुरुआत में देरी के लिए 0 से 86400000 मिलीसेकंड पूर्णांक या `null`।
focusOnContent / focus_on_content	boolean | null	`true` / `false`, `1` / `0` या `null` (आंतरिक मोडल सामग्री पर फ़ोकस)।

CDN से `addaw-wba11y.min.js` देते समय डोमेन Referer हेडर से लिया जाता है। यदि उस डोमेन के लिए विकल्प सहेजे हैं तो स्क्रिप्ट से पहले `window.AddawConfig = { ... };` जोड़ा जाता है ताकि ऑटो-स्टार्ट से पहले लागू हों (उपयोगकर्ता स्थानीय स्टोरेज से प्राथमिकता रख सकता है — विजेट अनुभाग में क्रम देखें)।

$ch = curl_init('https://panel.addaw.org/webService/ApiEmpleadoPersonalizarDominio');
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'Authorization: Bearer ' . $token,
    'Content-Type: application/json',
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode([
    'dominio' => 'example.com',
    'color'   => 2,
    'lang'    => 'es',
    'position' => 'left',
]));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = json_decode(curl_exec($ch), true);
curl_close($ch);

// Ejemplo JavaScript con fetch
await fetch('https://panel.addaw.org/webService/ApiEmpleadoPersonalizarDominio', {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${token}`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    dominio: 'example.com',
    color: 2,
    lang: 'es',
    position: 'left',
    autoInit: true,
    dark_mode: false,
    logo_url: 'https://example.com/logo.svg',
    logo_link: 'https://example.com',
    delay: 1200,
    focusOnContent: true
  })
});

Errores comunes y buenas practicas

• Si quieres limpiar un valor almacenado para un dominio, envia esa clave con null.
• Usa siempre HTTPS y valida la expiracion del token en tu backend.
• La alta de dominio es idempotente: si ya existe, no se duplica.
• Al servir el widget por CDN, verifica que el dominio de Referer coincide con el esperado.

Endpoint de estadisticas del widget

Ademas de la API de dominios, el widget envia agregados diarios de uso a:

Este endpoint acepta JSON con events y suma contadores por dominio/dia/accion. Solo procesa claves permitidas (por ejemplo panel_open, tool_*, profile_*, blind_*).

await fetch('https://api.addaw.org/webService/widgetInteractionStats', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({
    events: {
      panel_open: 1,
      panel_close: 1,
      tool_zoom: 3,
      profile_dyslexia: 1
    }
  })
});

Como obtener estadisticas por dominio

En la API publica actual no existe un endpoint ApiEmpleado* especifico para leer series historicas de estadisticas por dominio con Bearer. La consulta por dominio se resuelve hoy desde el panel interno.

1) Vista de analitica por dominio (panel)

Esta ruta requiere sesion de panel y muestra metricas de cargas e interacciones del dominio.

• desde: fecha inicio en formato YYYY-MM-DD.
• hasta: fecha fin en formato YYYY-MM-DD.
• Si no se envian, el panel usa por defecto los ultimos 30 dias.
• Rango maximo permitido por el backend: 90 dias.

# Ejemplo (navegador con sesion iniciada en panel)
https://panel.addaw.org/Widget/Dominios/example.com?desde=2026-04-01&hasta=2026-04-20

2) Metricas calculadas en esa vista

3) Consulta directa en BBDD (entornos internos)

-- Cargas diarias de un dominio
SELECT stat_date AS dia, SUM(request_count) AS total
FROM widget_domain_loads_daily
WHERE domain_normalized = 'example.com'
  AND stat_date BETWEEN '2026-04-01' AND '2026-04-20'
GROUP BY stat_date
ORDER BY stat_date;

-- Interacciones diarias de un dominio
SELECT stat_date AS dia, SUM(event_count) AS total
FROM widget_interaction_daily
WHERE domain_normalized = 'example.com'
  AND stat_date BETWEEN '2026-04-01' AND '2026-04-20'
GROUP BY stat_date
ORDER BY stat_date;

-- Top acciones por dominio
SELECT action_key, SUM(event_count) AS total
FROM widget_interaction_daily
WHERE domain_normalized = 'example.com'
  AND stat_date BETWEEN '2026-04-01' AND '2026-04-20'
GROUP BY action_key
ORDER BY total DESC
LIMIT 15;