Digital Documents

As APIs de Digital Documents da Hiperstream são projetadas para permitir a gestão eficaz da comunicação digital, proporcionando às empresas ferramentas robustas para manipulação de documentos digitais. Antes de explorar as APIs individuais, é essencial entender os conceitos fundamentais que sustentam a funcionalidade da plataforma.

Conceitos Fundamentais

Channels

Os "Channels" referem-se aos canais de comunicação que a Hiperstream possibilita para a entrega de documentos. Isso inclui uma variedade de métodos, tais como SMS, WhatsApp, RCS, Email, Notificação de App, WebHooks, entre outros, permitindo que as comunicações sejam adaptadas às preferências e necessidades dos clientes.

Views

"Views" são configurações de indexação que determinam a unicidade de cada documento na plataforma da Hiperstream. Uma View é definida pela combinação de um ou mais campos que, quando usados em conjunto, criam um identificador exclusivo para um documento. As Views permitem que os documentos sejam recuperados e gerenciados de forma eficiente e segura.

APIs de Digital Documents

A Hiperstream oferece três APIs principais dentro de seu serviço de Digital Documents:

1. Download

Esta API permite que os usuários baixem uma representação em PDF do documento de comunicação, com base em um identificador e, opcionalmente, uma data de referência e uma ViewId.

Parâmetros da API de Download:

• identifier (string): Identificador do documento, geralmente o número do contrato.
• referenceDate (date): Data de referência do documento (opcional).
• viewId (string): Identificação da View usada para indexar o documento.
• companyId (string): ID único da empresa que está chamando a API.

2. Retrieve by Unique ID

Retorna a representação de um documento de comunicação em PDF, usando um identificador único gerado pela Hiperstream.

Parâmetros da API de Retrieve by Unique ID:

• id (string): Identificador único do documento.
• fileTypeId (string): Identificador do tipo de arquivo.
• companyId (string): ID único da empresa que está chamando a API.

3. Send

Esta API reenvia um documento para o cliente através de um canal de comunicação pré-definido ou alternativo.

Parâmetros da API de Send:

• identifier (string): Identificador do documento.
• referenceDate (date): Data de referência do documento.
• viewId (string): Identificação da View usada para indexar o documento.
• channelTypeId (string): ID do canal de saída do documento (opcional).
• content (object): Contém o email ou telefone para onde o documento será enviado.
• companyId (string): ID único da empresa que está chamando a API.

4. View

Esta API lista todos os tipos de Views disponíveis para o cliente, facilitando a identificação e recuperação de documentos específicos.

Parâmetros da API de View:

• companyId (string): ID único da empresa que está chamando a API.

📘

Para mais informações sobre como integrar estas APIs ao seu sistema, acesse a documentação técnica detalhada.