Visão Geral da Integração de Parceiros

Bem-vindo ao portal de integração técnica do Yzex Connect. Este espaço foi projetado para fornecer aos times de engenharia e parceiros técnicos (como ERPs e plataformas de atendimento) todos os insumos necessários para conectar seus sistemas aos nossos serviços de mensageria e automação operacional.

Arquitetura de Integração

O ecossistema Yzex Connect disponibiliza interfaces modernas e padronizadas para comunicação síncrona e assíncrona:

APIs RESTful (OpenAPI 3.1): Endpoints HTTP protegidos por Bearer Token e chaves de API para provisionamento, gerenciamento de instâncias e disparo de mensagens.
Webhooks Confiáveis: Disparo de eventos de ciclo de vida e mensagens em tempo real com garantia de entrega At-Least-Once e autenticação criptográfica HMAC-SHA256.
Controle de Vazão (Rate Limiting): Headers padronizados (RateLimit-Limit, RateLimit-Remaining, Retry-After) para proteção de recursos e previsibilidade de tráfego.

Estrutura de Documentação (Diátaxis)

A documentação está organizada conforme os 4 pilares do framework Diátaxis:

Categoria	Finalidade
Tutorials	Guias passo a passo voltados a orientar o onboarding prático de novas integrações.
How-To Guides	Receitas prescritivas focadas na resolução de problemas operacionais e segurança.
Reference	Contratos estritos de API (OpenAPI 3.1) e catálogo de eventos de webhook.
Explanation	Fundamentação técnica sobre garantias de idempotência, resiliência e SLAs.

Categoria

Finalidade

Tutorials

Guias passo a passo voltados a orientar o onboarding prático de novas integrações.

How-To Guides

Receitas prescritivas focadas na resolução de problemas operacionais e segurança.

Reference

Contratos estritos de API (OpenAPI 3.1) e catálogo de eventos de webhook.

Explanation

Fundamentação técnica sobre garantias de idempotência, resiliência e SLAs.