​
Parâmetros de configuração

  • Documentos - Uma lista de documentos a serem criados;

​
Parâmetros dos documentos

  • Propósito do documento - O propósito do documento a ser criado;
  • Configurações da engine
    • Tipo da engine - Template engine usado para gerar documentos. Atualmente apenas o Google é suportado.
    • Opções da engine
      • Template - ID do template a ser usado para gerar o documento.

​
Exemplos

​
Passo para criar CCB

Para a criação de uma CCB, configure o passo da seguinte forma:

curl --request POST \
    --url https://api.base39.io/v1/products/<id> \
    --header 'authorization: Basic <sua-api-key>' \
    --data '
    {
        "settings": {
            "steps": {
                "criarDocumentos": {
                    "title": "Cria documentos do empréstimo",
                    "type": "create_documents",
                    "methodData": {
                        "documents": [
                            {
                                "purpose": "ccb",
                                "engine": {
                                    "options": {
                                        "template": "<template-id>"
                                    },
                                    "type": "google"
                                }
                            }
                        ]
                    },
                },
                // ...
            }
        }
    }
    '

​
Passo para criar CCB e assinatura

Para a criação de uma CCB, configure o passo da seguinte forma:

curl --request POST \
    --url https://api.base39.io/v1/products/<id> \
    --header 'authorization: Basic <sua-api-key>' \
    --data '
    {
        "settings": {
            "steps": {
                "criarDocumentos": {
                    "title": "Cria documentos do empréstimo",
                    "type": "create_documents",
                    "methodData": {
                        "documents": [
                            {
                                "purpose": "ccb",
                                "engine": {
                                "options": {
                                    "template": "<template-id>"
                                },
                                "type": "google"
                                }
                            },
                            {
                                "purpose": "signature",
                                "engine": {
                                "options": {
                                    "template": "<template-id>"
                                },
                                "type": "google"
                                }
                            }
                        ]
                    },
                },
                // ...
            }
        }
    }
    '