 API

Com a API do DiMaker, você pode criar arquivos com dados personalizados e disponibilizá-los aos destinatários, se necessário. As requisições para a API podem ser realizadas tanto de outro servidor quanto diretamente do navegador via CORS.

Como começar

Na seção "Integração" - "Tokens API", é necessário obter um token seguro (Secure Token) e ativar sua utilização. Além disso, é imprescindível criar um documento contendo variáveis para os dados personalizados, um modelo de e-mail para envio em massa e uma pasta no Disco para armazenar os arquivos gerados.

Criação de arquivos

Para gerar arquivos, envie requisições POST-DATA, POST- ou GET para o endereço abaixo:
https://dimaker.app/api/v1/create/
com os dados listados a seguir.
A codificação da solicitação deve ser UTF-8. Campos obrigatórios estão marcados com um asterisco (*).

• secure*

  Token seguro (string, 36 caracteres)

• doc_id*

  ID do documento (string, 36 caracteres) que será usado para criar o arquivo. Você pode encontrar o ID na URL ao abrir o documento. O documento não deve estar na lixeira, mas pode estar armazenado em qualquer pasta.

• mask*

  String contendo todas as variáveis para substituição no formato chave (variável) - valor (texto para substituição). Pode incluir dados para geração de vários arquivos simultaneamente (sem limite de quantidade).
  Exemplo para um único arquivo:
  [{"%name": "Silva", "%notas":"100"}]
  Exemplo para múltiplos arquivos:
  [{"%name": "Silva", "%notas":"100"}, {"%name": "Santos", "%notas":"200"}, {"%name": "Oliveira", "%notas":"300"}]
  Para especificar um endereço de e-mail, utilize %email. Para definir o nome do arquivo, use %filename. No caso de envio de arquivos criados para múltiplos e-mails, indique os endereços separados por vírgula, porém o status de envio no Disco será exibido apenas pelo primeiro endereço.

  Para incluir uma imagem em um bloco, você pode usar um link direto (http:// ou https://) ou uma imagem codificada em Base64. Neste último caso, a string deve começar com "data:image/".

  Método alternativo
  Se não for possível enviar uma string , pode-se enviar as variáveis substituíveis como campos separados na solicitação. Cada variável deve começar com o prefixo mask_, por exemplo, mask_name para a variável %name. Para definir um e-mail, utilize mask_email, e para o nome do arquivo, mask_filename.

• mail_id

  ID do modelo de e-mail (string, 36 caracteres) usado para o envio. Este ID pode ser encontrado na URL ao abrir o modelo de e-mail. Caso esta variável não seja enviada, o e-mail não será enviado.

• email_send

  O momento do envio do e-mail com o arquivo. Pode assumir os seguintes valores:
  onfinish - Enviar todos os e-mails após a criação de todos os arquivos (padrão).
  oncreate - Enviar o e-mail logo após a criação de cada arquivo. No caso de um único arquivo, onfinish e oncreate são equivalentes.
  timeout - Enviar após um intervalo de tempo. Para isso, envie mais dois parâmetros:
  email_timeout_value - valor numérico do intervalo (número inteiro).
  email_timeout_unit - unidade do intervalo: "m" (minutos), "h" (horas) ou "d" (dias).
  Ou para especificar um horário exato, envie o tempo em formato UNIX no campo email_timeout_timestamp. Caso ambos sejam fornecidos, email_timeout_timestamp terá prioridade.

• folder_id

  ID da pasta no Disco (string, 36 caracteres) para guardar os arquivos gerados. Se a pasta não existir, será criada automaticamente ao salvar o primeiro arquivo.

• page_id

  Número da página (número ou string), caso o documento tenha múltiplas páginas. Pode enviar um único número (primeira página = 0) ou uma lista separada por vírgulas com as páginas que deseja usar na criação do arquivo.

• result

  Define o formato do retorno da API. Pode assumir os seguintes valores:

  • Vazio. Será retornada uma string com o resultado da solicitação.
  • link. Retorna um link para o arquivo gerado (primeiro arquivo, se múltiplos forem criados). Pode haver um curto atraso de 1 a 5 segundos na geração do arquivo. A solicitação ao link antes da criação resultará em erro 404.
  • file. Retorna diretamente o arquivo gerado (somente o primeiro, no caso de vários). Note que a geração pode levar de 1 a 5 segundos por arquivo. Solicitações em massa podem aumentar o tempo necessário. Após 30 segundos sem resposta, o servidor retornará erro 404.

Resultado

O servidor retorna uma string nos seguintes formatos:

• result

  Resultado da solicitação:
  error - erro na solicitação; nenhum arquivo foi gerado.
  success - sucesso na criação do(s) arquivo(s).

• create_id

  ID da geração, útil para futuras requisições relacionadas (somente no caso de sucesso).

• files

  Matriz com IDs dos arquivos gerados. Esses IDs podem ser usados para baixá-los no formato necessário (JPG ou PDF).

• url

  URL para exibição de um widget de download dos arquivos. Para utilizar, insira o URL em um iframe.

• error_text

  Descrição do erro (se houver).

Outras integrações