Documents On Demand

As APIs de Document On Demand da Hiperstream permitem a geração e envio de comunicações em tempo real, com a capacidade de criar documentos de forma dinâmica conforme a demanda. Estas APIs são poderosas ferramentas para empresas que requerem flexibilidade e agilidade na comunicação com clientes.

Conceitos Fundamentais

Workflow

Cada jornada financeira no HiperCCM é representada por um workflow. Este fluxo inclui as etapas de ingestão, normalização, validação de dados, personalização e o roteiro de envio das comunicações. O workflow é a espinha dorsal do processo e garante que cada documento seja processado de acordo com regras específicas.

Document Template

Os modelos de documentos são estruturas pré-definidas que orientam a criação de documentos no HiperCCM. Estes modelos podem ser customizados pelo cliente ou definidos com auxílio de nossa equipe de consultoria.

APIs de Document On Demand

API de Preview

Esta API gera um documento em tempo real codificado em base64, que não é armazenado no módulo biblioteca.

Endpoint: /v1/communications/preview

Parâmetros:

• workflowId (string): ID único do fluxo de processamento.
• documentTemplateId (string): Modelo do documento a ser gerado.
• content (object): Dados necessários para a geração do documento.

API de Send

Cria um documento em tempo real e inicia o processo de comunicação baseado no fluxo definido.

Endpoint: /v1/communications/send

Parâmetros:

• workflowId (string): ID único do fluxo de processamento.
• documentTemplateId (string): Modelo do documento a ser gerado.
• content (object): Dados utilizados na geração do documento e comunicação.

API de ReSend

Reenvia um documento disponível na empresa em formato base64, seguindo o fluxo configurado.

Endpoint: /v1/communications/resend

Parâmetros:

• workflowId (string): ID único do fluxo de processamento.
• content (object): Documento em base64 e dados extras para o processo de reenvio.

Utilização das APIs

Para utilizar as APIs de Document On Demand, é necessário ter um workflow configurado e um modelo de comunicação definido. Com esses elementos, as APIs podem ser integradas para gerar documentos dinâmicos e realizar a comunicação em tempo real com os clientes.

Comportamento e Expectativas das APIs:

• A natureza assíncrona das APIs de Send e Resend significa que, enquanto o código 200 confirma o início do processo, o status final do envio não é imediatamente conhecido através da API.
• Não existe atualmente uma API dedicada para verificar o status de envio das comunicações criadas. O acompanhamento é realizado pelo Dashboard do HiperCCM.