API Reference

Contrato público para widget, autenticação e conversas em /api/v1

Esta superfície concentra a referência operacional: OpenAPI 3.1 em YAML, Swagger UI, Redoc e pack Postman para validar a integração sem depender da equipa VZO.

Abrir Swagger Abrir Redoc Baixar OpenAPI YAML Ver Postman

Artefactos base

OpenAPI JSON

vv1

/openapi/chatbeep.v1.json

OpenAPI YAML

vv1

/openapi/chatbeep.v1.yaml

Postman Collection

Preparado

/developers/downloads/postman/collection

Coverage

O que esta API já cobre

Health e observabilidade mínima para validar a plataforma.

Widget público: config, heartbeat, criação de conversa e timeline.

Auth mobile, listagem de conversas e ações operacionais do atendente.

API Keys, OAuth e webhooks outbound ficam fora do contrato público atual e seguem para roadmap.

SDK readiness

Pacotes já alinhados com esta referência

JavaScript SDK

Wrapper browser-first para instalar, abrir, fechar, identificar e observar o widget com uma API mais ergonómica.

v0.1.0

npm install @chatbeep/js

SDK PHP

Cliente PHP sem framework para o widget, health, login mobile e operações server-to-server futuras.

v0.1.0

composer require chatbeep/php-sdk

SDK Laravel

Wrapper Laravel com Service Provider, configuracao e facade pronta para apps do ecossistema.

v0.1.0

composer require chatbeep/laravel-sdk

SDK NodeJS

Cliente NodeJS com fetch para automacoes, webhooks e operacoes server-to-server.

v0.1.0

npm install @chatbeep/node-sdk

.NET SDK

Cliente .NET preparado para publicar no NuGet com foco em autenticação, conversas e webhooks.

v0.1.0

dotnet add package Chatbeep.Sdk --version 0.1.0