Especificação OpenAPI 3.1 dos Endpoints Públicos

A API pública do Yzex Connect é integralmente documentada sob a especificação OpenAPI 3.1.

Endpoints Principais

1. Instâncias de Mensageria

  • GET /v1/instances — Lista instâncias vinculadas à organização parceira.

  • POST /v1/instances — Cria e provisiona uma nova instância.

  • GET /v1/instances/{name}/status — Consulta status de conectividade em tempo real.

  • DELETE /v1/instances/{name} — Desconecta e remove a instância.

2. Envio de Mensagens

  • POST /v1/messages/text — Dispara mensagem de texto simples.

  • POST /v1/messages/media — Envia documentos, áudio ou imagens via URL ou multipart.

Download do Contrato

O arquivo canônico OpenAPI em formato JSON pode ser obtido via: GET https://api.yzex.com.br/v1/openapi.json