Geração de documentos

Utilize essa API para geração do documento

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.

• 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.

Gerar documentos

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

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

Headers

Name	Type	Description
Content-Type*	string	application/json
Authorization*	string	Bearer [OAUTH2-AUTHENTICATION-ACCESS_TOKEN]
TenantId*	string	[TENANT-ID] - Identifica a qual conta previamente cadastrada na aplicação deve ser utilizada. Essa informação é fornecida pela D1.

Request Body

Name	Type	Description
documents*	array	correlationId: número do documento que será referenciado no retorno. maskid: nome da máscara utilizada para gerar o documento, esse valor é fornecido pela D1. Passe essa propriedade nula ou vazia para utilizar o ID da máscara configurado dentro da caixinha de documentos da jornada. sign: campo booleano se o documento deve ser gerado assinado. passwordProtect: campo booleano se o documento deve ser gerado com proteção por senha. Para o funcionamento desse campo deve ser combinado no desenvolvimento do documento com a D1. fields: lista de valores utilizados para gerar o documento, esses campos são combinados com a D1 e deve ser respeitado conforme implantação do projeto.
documents	string	filename: define o nome do PDF a ser gerado. O cadastro é opcional.

200: OK Documento criado

Atributos:

correlationId: número do documento que foi enviado.

documentLink: url do documento gerado.

storagePath: caminho físico do documento dentro do storage.

documentName: nome do documento gerado.

[{
    "correlationId":"345OIGDF98345T",
    "documentLink":"https://ststoraged1dev.blob.core.windows.net/directone/2646b220-e4c7-4127-a1f0-5782f06c4aee.pdf",
    "storagePath":"/directone/2646b220-e4c7-4127-a1f0-5782f06c4aee.pdf",
    "documentName":"2646b220-e4c7-4127-a1f0-5782f06c4aee"
}]

400: Bad Request Erro ao gerar documento

Atributos:

type: sempre será “about:blank”

title: sempre será “BadRequest”

status: sempre será 400

detail: conterá informações detalhadas sobre o erro

{
    "type": "about:blank",
    "title": "BadRequest"
    "status": 400
    "detail": "Detalhes sobre o erro"
    "instance": "/v1/document"
}

Body de exemplo

{
    "documents": [{
        "correlationId": "345OIGDF98345T",
        "maskId": "fatura_reportmodelo",
        "sign": true,
        "passwordProtect": false,
        "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"
        "filename: ZENVIA123,
        }
    }
]
}