Para desarrolladores

Documentación API

Integra Kotkot con tus sistemas y flujos de trabajo existentes mediante nuestra API RESTful.

API v1.0 — Estable
zap

REST API

API RESTful completa para gestionar conversaciones, cotizaciones, clientes y más.

webhook

Webhooks

Recibe notificaciones en tiempo real sobre eventos importantes en tu cuenta.

key

Autenticación

Autenticación segura mediante API keys con permisos granulares.

shield

Rate Limiting

Límites justos de rate limiting para garantizar disponibilidad para todos.

code

Quick Start

JavaScript / TypeScript
# Instalación
npm install @kotkot/sdk

# Configuración
import Kotkot from '@kotkot/sdk';

const client = new Kotkot({
  apiKey: 'tu_api_key',
  environment: 'production', // o 'sandbox'
});

# Ejemplo: Listar conversaciones
const conversations = await client.conversations.list({
  limit: 10,
  status: 'active',
});

# Ejemplo: Crear una cotización
const quote = await client.quotes.create({
  clientId: 'cli_123',
  productType: 'auto',
  coverageAmount: 25000,
  duration: 12,
});
lock

Autenticación Requerida

Para usar la API, necesitas un API key. Puedes generar una desde tu dashboard en Configuración → API Keys.

book open

Endpoints Disponibles

terminal

Conversaciones

Gestiona conversaciones de WhatsApp

GET/api/v1/conversationsListar conversaciones
GET/api/v1/conversations/:idObtener conversación
POST/api/v1/conversationsCrear conversación
PATCH/api/v1/conversations/:idActualizar conversación
file text

Cotizaciones

Gestiona cotizaciones de seguros

GET/api/v1/quotesListar cotizaciones
GET/api/v1/quotes/:idObtener cotización
POST/api/v1/quotesCrear cotización
PATCH/api/v1/quotes/:idActualizar cotización
database

Clientes

Gestiona tu base de clientes

GET/api/v1/clientsListar clientes
GET/api/v1/clients/:idObtener cliente
POST/api/v1/clientsCrear cliente
PATCH/api/v1/clients/:idActualizar cliente
DELETE/api/v1/clients/:idEliminar cliente
webhook

Webhooks

Configura webhooks para eventos

GET/api/v1/webhooksListar webhooks
POST/api/v1/webhooksCrear webhook
DELETE/api/v1/webhooks/:idEliminar webhook

Documentación Completa

Esta página es un resumen de la API. Para documentación completa con todos los parámetros, respuestas, códigos de error y ejemplos, visita nuestra documentación interactiva.