​
Introducción

Con el SDK de Plazbot, puedes crear Portales de IA, tipo ChatGPT para tus clientes y que tu agente pueda contestar todas las preguntas que necesiten de forma humana: Puedes implementar IA de Atención al cliente, Ventas, Soporte, etc.

​
Inicialización.

Para poder iniciar el objeto del Portal se necesita implementarlo con el API Key y con el Workspace ID. Recordar que para la inicialización necesita colocar la Región donde se encuentra su plataforma de Plazbot, puede ser LA (LATAM) o EU (EUROPA).
npm
import { Portal } from 'plazbot';

const portal = new Portal({
  workspaceId: "[YOUR_WORKSPACE_ID]",
  apiKey: "[YOUR_API_KEY]",
  zone: "LA" // Use "EU" for Europe
});

​
Creación del Portal.

Crea un nuevo portal con la configuración de la interfaz de usuario (título, subtítulo, imagen de marca, etc.).
🚨 Importante: Es fundamental asociar un agente a un portal para que funcione. El portal debe tener al menos un agente asociado; de lo contrario, no se cargará y mostrará un mensaje. La asociación se realiza mediante el siguiente método en esta documentación.✅ Beneficio: Con este portal, puede tener tantos agentes como desee: un agente para Ventas, otro para Atención al Cliente, otro para Soporte, etc.
npm
const portalCreated = await portal.addPortal({
name: "Portal Search",
zone: "LA",
title: "Welcome to Portal Search",
subtitle: "Tu fuente de historia confiable",
logo: "https://storage-files-plz-latam.s3.sa-east-1.amazonaws.com/master/logo-plazbot.png",
logodark: "https://storage-files-plz-latam.s3.sa-east-1.amazonaws.com/master/logo-plazbot.png",
access: "direct", // or "form",
theme: "light", // or "dark",
disabled: false, // Disable the portal
brandOff: false, // Disable the plazbot brand
});

const portalId = portalCreated.id;
const portalUrl = portalCreated.url;
Campos de Creación del Portal
NameDescription
nameNombre del portal. Texto visible para identificación.
promptInstrucciones personalizadas que definen el comportamiento del agente.
titleEs el título que aparece en la parte superior del portal..
subtitleInformación de referencia del portal.
logoLogotipo que aparece en la sección superior izquierda cuando está en modo claro.
logodarkLogotipo que aparece en la sección superior izquierda cuando está en modo oscuro.
accessPara acceder al portal, haz lo siguiente: formulario/directo. Actualmente, recomendamos usar el modo directo, ya que aún estamos desarrollando el modo “formulario”. Si necesitas alguna función, no olvides dejarla en nuestra sección de comentarios.
themeCampo que te indica como deseas que este el portal con tema claro u oscuro.
disabledCampo que desactiva y activa el portal.
brandOffCampo que oculta el saludo de Plazbot en la parte inferior del portal.
zoneLa zona es un factor muy importante; debe coincidir con la zona donde se creó la cuenta. Puede ser de dos tipos: LA/EU (Latam/Europa).
  • Al crear el portal te enviará la URL para que puedas iniciar sesión y realizar consultas al agente de IA.
https://appla.plazbot.com/portal?id={PORTAL_ID}&workspaceId={WORKSPACE_ID}
Añade un enlace externo (ej.”Blog”) al portal. Se permiten un máximo de 5 enlaces. Los enlaces se mostrarán debajo del portal y se configurarán para abrirse en otra pantalla.
npm
     //Add a link to the portal
    await portal.addLinkToPortal({
      portalId: portalId,
      value: "Blog Plazbot",
      url: "https://www.plazbot.com/Blog"
    });

     //Add a link to the portal
    await portal.addLinkToPortal({
      portalId: portalId,
      value: "Discord Plazbot",
      url: "https://discord.gg/SgyAtrwzp7"
    });

     //Add a link to the portal
    await portal.addLinkToPortal({
      portalId: portalId,
      value: "Plazbot",
      url: "https://www.plazbot.com"
    });

​
Extraer Portal

Extrae la información del Portal por ID
npm
const portalInfo = await portal.getPortal(portalId);
console.log("🔍 Portal:", portalInfo);
Elimina todos los links configurados en la plataforma.
npm
await portal.clearLinks(portalId);

​
Actualizar Portal

Actualizar el Portal por los campos que necesites.
npm
await portal.updatePortal({
id: portalId, 
name: "Plazbot Portal Updated"
});

​
Eliminar Portal

Eliminar el Portar por ID 
await portal.deletePortal(portalId);