PLplugsign

POST Create team user

Changed on

Com este endpoint você pode criar contas de colaboradores, para que os mesmos possuam acesso ao sistema via front-end e possam utilizar a plataforma, assim como visualizar os dados submetidos via API.

Caso não queira fornecer acessos aos colaboradores, é possível manipular o sistema sem tais contas, executando todas as ações como administrador do sistema.

Atenção! Ao criar uma conta de colaborador, é possível avisá-lo ou não da criação. Caso você informe o parâmetro password, ele não será avisado da criação da conta nem receberá alertas do sistema (para uso WhiteLabel). Caso NÃO passe uma senha, o sistema vai gerar uma automaticamente e enviar para o e-mail do colaborador, portanto ele terá conhecimento da conta e uma forma de acessar a plataforma.

Regras:

  • permissions é obrigatório e precisa ter pelo menos um valor (um array vazio responde 422).
  • cpf aceita apenas números (um CPF formatado responde 422).
  • cert_file e signature como arquivo exigem multipart/form-data; o editor desta página não suporta esse formato.
  • Se o e-mail já existe em outra empresa, o usuário existente é apenas vinculado à sua empresa com o cargo e as permissões informados; nome, senha, certificado e assinatura enviados são ignorados e nenhum e-mail é enviado.
  • Sem role, o cargo padrão é staff.
  • A mensagem de sucesso é a mesma mesmo quando password foi informada (nesse caso nenhum e-mail é enviado).
post/api/teams

Request

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

Request body

namestring required

Primeiro nome do colaborador.

last_namestring required

Sobrenome do colaborador.

birthstring date

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

phonestring

Telefone com DDD e 9 (ex.: 11999999999). Usado para as notificações por WhatsApp, quando habilitadas.

emailstring required

E-mail do colaborador (identificador único da conta).

cpfstring

CPF válido, apenas números (ex.: 52998224725). Formatado é rejeitado.

recive_email0 | 1 | 2

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

recive_whatsapp0 | 1 | 2

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

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.

passwordstring

Senha de acesso do colaborador. Se omitida, ele recebe um e-mail para criar a senha; se informada, nenhum e-mail é enviado (uso white label).

permissionsstring[] required

Permissões do colaborador. Obrigatório, com pelo menos um valor.

role'admin' | 'user' | 'staff'

Cargo do colaborador: admin, staff ou user. Padrão: staff.

signaturestring binary

Imagem da assinatura do colaborador: arquivo PNG ou JPG de até 5024 KB (multipart/form-data) ou string base64 (data URI ou base64 puro). Se omitida, a plataforma gera uma assinatura padrão a partir do nome.

Response

200

messagestring

Mensagem de confirmação (enviada mesmo quando password foi informada).

Example response

{
  "data": {
    "id": 1,
    "name": "João",
    "last_name": "Silva",
    "email": "developer@exemplo.com",
    "phone": "11-99999-9999",
    "permissions": [
      "upload"
    ],
    "recive_email": 1,
    "recive_whatsapp": 1,
    "role": "staff",
    "status": "Active",
    "birth": "1990-05-12"
  },
  "message": "Tudo pronto! Conta criada com sucesso! O colaborador vai receber um e-mail para criar sua senha."
}

Changes

  • 3db1513040eaRevision changes
    • breaking

      request property / was restricted to a list of enum values

    • 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 staff 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 new delete enum value to the request property /

    • info

      added the new edit enum value to the request property /

    • info

      added the new protect enum value to the request property /

    • info

      added the new send_request enum value to the request property /

    • info

      added the new upload enum value to the request property /

    • info

      added the new view_all_requests 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