POST Create customer

Changed on

Com a criação de clientes é possível disponibilizar contas no ambiente visual para que os clientes da empresa assinem documentos logados e tenham acesso rápido aos seus documentos. <br><br> As contas para clientes são do modo "Read only", portanto não podem visualizar informações, criar pastas, enviar documentos nem fazer nenhuma ação no sistema além de assinar documentos para os quais recebeu uma solicitação de assinatura. <br><br> As principais vantagens para se criar uma conta de cliente são: <br><br> 1. Na solicitação de assinatura pelo front-end, você não precisará digitar os e-mails, basta selecionar na lista de clientes. <br><br> 2. Seu cliente não vai precisar procurar no e-mail links de documentos antigos que assinou, acessando a plataforma vai ver todos na pasta "Compartilhados comigo". <br><br> 3. Seu cliente não vai precisar criar a sua assinatura sempre que for assinar um documento, ele vai poder assinar logado com apenas 2 cliques. <br><br> Atenção! A criação de conta <b>NÃO É OBRIGATÓRIA</b> para assinar documentos, é possível solicitar assinaturas apenas pelo e-mail, a conta é um recurso que busca facilitar o dia a dia de clientes que assinam muitos documentos, portanto não é algo mandatório <br><br> <b>Os clientes ou "Customers" são os clientes da empresa que envia os documentos, para criar subcontas empresariais em implantações para terceiros verifique os endpoints "Companies"</b><p><strong>Regras:</strong></p><ul><li>Padrões quando omitidos: <code>recive_email</code> = 2 e <code>recive_whatsapp</code> = 1.</li><li><code>cert_file</code> como arquivo exige <code>multipart/form-data</code>; o editor desta página não suporta esse formato.</li><li>Se o e-mail já existe em outra empresa, o usuário existente é apenas vinculado à sua empresa como cliente; nome, senha e certificado enviados são ignorados.</li><li>Sem <code>password</code>, o cliente recebe por e-mail uma senha gerada pela plataforma; com <code>password</code>, nenhum e-mail é enviado.</li></ul>

post/api/customers

Request

  • Base URL
    https://app.plugsign.com.br
  • URL
    https://app.plugsign.com.br/api/customers
  • Auth
    API key in header Authorization

Request body

namestring required

Primeiro nome do cliente adicionado na plataforma.

last_namestring required

Sobrenome do cliente adicionado na plataforma.

birthstring date

Data de nascimento do cliente no formato ano-mês-dia. Exemplo: 1990-05-12.

emailstring required

Endereço de e-mail do cliente adicionado na plataforma.

phonestring required

Telefone com DDD e 9 (ex.: 11999999999). Usado para WhatsApp quando habilitado.

addressstring required

Endereço do seu cliente adicionado na plataforma.

recive_email0 | 1 | 2

Recebimento de e-mails: 0 = não recebe nada, 1 = recebe tudo, 2 = recebe somente solicitações. Padrão: 2.

recive_whatsapp0 | 1 | 2

Recebimento de mensagens de WhatsApp: 0 = não recebe nada, 1 = recebe tudo, 2 = recebe somente solicitações. Padrão: 1.

cpfstring

CPF válido, formatado ou apenas números.

passwordstring

Senha de acesso do cliente. Se omitida, a plataforma gera uma senha e envia por e-mail; se informada, nenhum e-mail é enviado.

cert_filestring binary

Arquivo do certificado digital (.pfx ou .p12). Enviar como arquivo em multipart/form-data; cert_password é obrigatória junto.

cert_passwordstring

Senha do certificado. Obrigatória quando cert_file é enviado; senha errada responde 401.

signaturestring

Assinatura do customer em base64. Envie o conteúdo base64 puro ou uma data URI, como data:image/png;base64,.... O conteúdo precisa decodificar para uma imagem válida e ter até 5 MB. Se omitida na criação, a API tenta gerar uma assinatura padrão com o nome do customer.

Response

200

messagestring

Mensagem de confirmação retornada pela API.

Example response

{
  "data": {
    "id": 289,
    "name": "Joaquim",
    "last_name": "Silva",
    "phone": "11999999999",
    "address": "Rua Nove de Julho, 1234, Centro, São Paulo",
    "email": "joaquim@teste.com.br",
    "birth": "1990-05-12",
    "role": "user",
    "recive_email": 2,
    "recive_whatsapp": 1
  },
  "message": "Cliente cadastrado com sucesso!"
}

Changes

    • breaking

      request property was restricted to a list of enum values

    • breaking

      request property was restricted to a list of enum values

    • breaking

      the request property type changed from string to integer

    • breaking

      the request property type changed from string to integer

    • info

      added the new optional request property

    • info

      the request property default value 2 was added

    • info

      the request property default value 1 was added

    • info

      added the new 0.00 enum value to the request property

    • info

      added the new 0.00 enum value to the request property

    • info

      added the new 1.00 enum value to the request property

    • info

      added the new 1.00 enum value to the request property

    • info

      added the new 2.00 enum value to the request property

    • info

      added the new 2.00 enum value to the request property

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status