Esta seção da documentação descreve detalhadamente os campos utilizados nas requisições e respostas da API, juntamente com as regras de negócio associadas a cada um deles. Aqui, você encontrará informações sobre:
- Definições dos campos: Nome, tipo de dado e formato esperado.
- Validações aplicadas: Regras obrigatórias, valores permitidos, e limites de tamanho ou intervalo.
- Dependências e relações: Campos que dependem de outros ou influenciam o comportamento da API.
- Comportamento padrão: Valores atribuídos automaticamente e tratamento de dados opcionais.
Nosso objetivo é garantir que você tenha uma compreensão clara de como interagir com os campos da API e evitar erros comuns durante a integração. Certifique-se de consultar esta seção ao construir ou validar suas requisições.
Campos e Regras de Negócio:
Descrição dos Campos
| Campo | Descrição | Tipo |
|---|---|---|
| name | Nome do arquivo do documento a ser criado. | string |
| color | A cor de identificação do template via interface. | string |
| content_base64 | Conteúdo do arquivo em formato base 64 que está sendo enviado para a Clicksign. | string |
Regras de Negócio para os campos
| Campo | Regras de Negócio |
|---|---|
| name | Informe uma extensão .docx. |
| color | Valores possíveis:
|
| content_base64 |
|
Regras dos campos para a Criação
Regras dos campos para a Atualização
| Campo | Obrigatório | Disponível |
|---|---|---|
| name | NÃO | SIM |
| color | NÃO | SIM |
| content_base64 | NÃO |
Conte com a nossa ajuda!
Estamos comprometidos em fornecer a você todas as ferramentas necessárias para simplificar e aprimorar seus processos de assinatura eletrônica. Não hesite em nos contatar se tiver alguma dúvida ou precisar de assistência adicional. Se precisar, entre em contato com nosso Time de Suporte.