Utilize essa API para geração do documento online (OnDemand). Para realizar a geração de um documento, é necessário que a API esteja devidamente autenticada e que um documento esteja corretamente configurado na plataforma.

⚠️ Atenção: Esta API é indicada para geração de documentos de até 200kb. O limite de TPS da API de geração de documentos OnDemand é de 4req/s.

 POST  URL: https://apicore.d1.cx/v2/document

Gerar documentos

Utilize esses parâmetros em ambiente de produção.

Request

Header

Model

Document Model

Observações:

• Campos assinalados com * não são obrigatórios e caso não sejam informados assumirão os valores padrões ou baseados em regras de negócio;
• Filenames e CorrelationIds não poderão se repetir dentro da lista de documentos;
• Filename assumirá um valor baseado no CorrelationId caso não seja informado;
• DocumentPassword será obrigatório quando PasswordProtect for verdadeiro;
• Context permite que documentos já existentes sejam gerados novamente, contanto que seu contexto, Filename e CorrelationId se mantenham os mesmos. Esta propriedade foi adicionada visando evitar cobranças duplicadas;
• IsTest permite que a geração de documentos ocorra em modo teste, evitando cobranças adicionais. Defina isTest como true pra gerar documentos em modo teste e false para executar a ação em ambiente de produção. Se o campo isTest não for incluído no modelo, a API assume automaticamente que seu valor é false, o que significa que o documento não será gerado em modo de teste.

Payload

{
    "contextId": "geracao-fatura-20230706",
    "isTest": true,
    "properties": {
        "codigo_transacao": "12ab34cd",
        "data_solicitacao": "2023-06-27"
    },
    "documents": [
        {
            "maskId": "fatura_reportmodelo",
            "filename": "ZENVIA123",
            "correlationId": "345OIGDF98345T",
            "sign": true,
            "passwordProtect": true,
            "documentPassword": "S3nh4PdF",
            "optionalMetadata": {
                "tipo_documento": "fatura"
            },
            "fields": {
                "linkBoleto": "https://boletoonline.acme.gov.br/imprimir/",
                "digital1": "012345678901234",
                "digital2": "01234567890123401234567890134",
                "primeiro_nome": "Transferência Boleto",
                "proposta": "0123456",
                "doc_total": "15,37",
                "link": "https://lnk.acme.io/",
                "vencimento": "1980-12-31T23:59:59.000Z",
                "nomeVendedor": "Rua João da Silva Filho",
                "cartao": "super cartao",
                "celularVendedor": "551199999999"
            }
        },
    ….
    ]
}

Responses (Standalone)

Status

Model

JSON

[
    {
        "documentName": "document1",
        "correlationId": "a1b2c3d4",
        "documentLink": "https://link-para-documento/document1.pdf",
        "storagePath": "/tenant/abc123/documento1.pdf"
    },
    {
        "documentName": "document2",
        "correlationId": "e5f6g7h8",
        "error": "falha ocorrida na geração do documento"
    }
]