Saltar al contenido principal

KintiSoft Javascript/Typescript SDK

NPM Version License: MIT

El SDK de JavaScript de KintiSoft ofrece una interfaz moderna, tipada y fácil de usar para interactuar con la API Pública de KintiSoft, compatible con entornos de navegador, Node.js, Angular, React, Vue y más.

Este SDK abstrae​

  • Autenticación
  • Configuración multi-tenant
  • Manejo de errores
  • Comunicación HTTP

Instalación​

npm install @kintisoft/sdk

o con yarn:

yarn add @kintisoft/sdk

Próximos pasos​

  1. Instala el SDK
  2. Configura autenticación
  3. Ejecuta el Inicio rápido

Instalación (Javascript)

El SDK de KintiSoft para Javascipt se distribuye a través de NPM y se instala usando npm o npx.

Requisitos:

  • Npm

Instalación​

npm install @kintisoft/sdk

o con yarn:

yarn add @kintisoft/sdk

Autenticación (Javascript)

La API pública de KintiSoft utiliza API Keys asociadas a un tenant para autenticar las solicitudes.

Credenciales requeridas:

  • tenant: Identificador de tu tenant
  • apiKey: Tu API Key privada

Configuración básica​

import { KintiSoftClient } from "@kintisoft/sdk";

const client = new KintiSoftClient({
  tenant: "acme",
  apiKey: "pk_public_xxxxxx",
});

Multi-tenant​

El SDK soporta entornos multi-tenant de forma nativa.

Seguridad:

  • No expongas tu API Key en código público
  • Usa variables de entorno cuando sea posible

Inicio rápido (Javascript)

Este ejemplo muestra cómo crear y listar prospectos usando el SDK de KintiSoft para Javascript.

Crear un porspecto​

import { KintiSoftClient } from "@kintisoft/sdk";

const client = new KintiSoftClient({
  tenant: "acme",
  apiKey: "pk_public_xxxxxx"
});

const response = await client.prospects.create({
  contact_name: "Juan Pérez",
  email: "juan@example.com",
  phone: "+593999999999",
  accept_ads: true,
  comment: "Lead generated from landing page"
});

console.log(response.message);