v1

latestOpenAPI 3.1.02026-08-041060342.7 KB

POST Create company

Com este endpoint, você pode criar uma subconta e, a partir disso, manipular a conta utilizando o seu respectivo token.

Esse processo permite que você gerencie subcontas de forma independente dentro do sistema.

post/api/companies

Request body

namestring required

Primeiro nome do administrador da empresa.

last_namestring required

Sobrenome do administrador da empresa (Limite de 80 caráctere).

company_namestring required

Nome da empresa cadastrada.

emailstring required

E-mail da empresa e do administrador da conta (O e-mail da empresa pode ser alterado depois, o do admin não, Limite de 255 carácteres).

phonestring required

Telefone da empresa, somente números com DDD, caso seja um celular com WhatsApp, o mesmo será utilizado nas comunicações.

company_brandstring binary

Logo da empresa.

company_iconstring binary

Ícone da empresa.

cnpjstring required

CNPJ da empresa devidamente formatado ou apenas números.

addressstring required

Endereço da empresa.

passwordstring

Senha de acesso do usuário administrador da empresa, caso não seja fornecida o sistema irá gerar uma senha temporária e enviará para ele por e-mail, caso passe uma senha, o sistema não vai avisa-lo sobre a criação da conta e não vai enviar alertas para o mesmo.

recive_whatsappstring

Se o usuário vai receber mensagens de WhatsApp do sistema, 0 = Não recebe nada, 1 = Recebe tudo, 2 = Recebe somente solicitações.

recive_emailstring

Se o usuário vai receber e-mails do sistema, 0 = Não recebe nada, 1 = Recebe tudo, 2 = Recebe somente solicitações.

mail_hoststring

Host do seu provedor de e-mails.

mail_fromstring

Qual endereço de e-mail está enviando a mensagem.

mail_usernamestring

Usuário de e-mail para autenticação (Na maioria dos casos é o mesmo do mail_from).

mail_passwordstring

Senha do e-mail.

mail_encryptionstring

Tipo de autenticação, aceito apenas tsl ou ssl.

mail_portinteger

Porta de saída do provedor, somente números.

can_loginboolean

Preencha este campo com 1 se a empresa está autorizada a acessar o sistema, e com 0 se não está autorizada.

payment_endstring

Formato d/m/Y. payment_end tem que ser maior que a data atual.

plugzapi_instancestring

Instância do PlugZapi.

plugzapi_tokenstring

Token do PlugZapi.

plugzapi_account_tokenstring

Account token do PlugZapi.

editablevalidateinteger

1 - QR Code no topo do documento (Sem página final). Ao solicitar a assinatura na última página, sem posicioná-la, a página final será sempre gerada automaticamente. 2 - Sem QR Code no topo, apenas página no final. 3 - Página final de validação e QR Code no cabeçalho (Criaremos páginas extras). 4 - QR Code no rodapé do documento (Sem página final). 5 - Página final de validação e QR Code no rodapé (Criaremos páginas extras). 6 - QR Code (Texto) na lateral esquerda. 7 - QR Code (Texto) na lateral direita.

unlimitedinteger

Quando ativado (True), nenhum custom limit será aplicado a empresa.

webhook_header_namestring

Nome do header customizado que é enviado no envio dos webhook para a URI cadastrada.

webhook_header_valuestring

Valor do header customizado que é enviado no envio dos webhook para a URI cadastrada.

reseller_loginboolean

Define se a empresa revendedora está autorizada a realizar login na subconta para fins de suporte. Quando habilitado (true), o administrador da revendedora poderá acessar a conta da parceira de forma ilimitada. Quando desabilitado (false), esse acesso é bloqueado.

Response

200

messagestring

Mensagem de confirmação retornada pela API.

token_typestring

Tipo do token de autenticação gerado.

tokenstring

Token de autenticação do administrador da empresa recém-criada.

Example response

{
  "message": "Cliente cadastrado com sucesso!",
  "token_type": "Bearer",
  "token": "ayJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9. eyJpc3MiOiJodHRwczpcLdvYXBwLnB33WdzaWduLmNvbS5icldYXBpXC9jbDkdjEsIm5iZiI6MTY2MTM0OTIyM2wianRpIjoiZU4Wdlp3R3dkVTI0STVleCIsInN1YiI6Mjg4LCJwcnYiOiIyM2JkNWM4OTQ5ZjYwMGFkYjM5ZTcwMWM0MDA4NzJkYjdhNTk3NmY3IiwiZW1haWwiOiJndWlsaGVybWVAdGVzdGUuY29tLmJyIn0.ErA0h7WOYNnKnEoqmZH_0ajI7nI7BgdDY1U5lyxRXgw",
  "company": {
    "id": 148,
    "name": "Empresa XYZ",
    "email": "exemplo@teste.com.br",
    "phone": "11999999999",
    "cnpj": "11.111.111/1111-11",
    "address": "Rua dos anjos, 123, Centro, São Paulo",
    "access": {
      "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1diJ9.eyJpc3MiOiJodHRwczpcL1wvYXBwLnBsdWdzaWduLm1vb25icpYXQiOjE2NjEzNDkyMjEsIm5iZiI6MTY2MTM0OTIyMSwianRpIjoiZUxWdlp3R3dkVTI0STVleCIsInN1YiI6Mjg4LCJwcnYiOiIyM2JkNWM4OTQ5ZjYwMGFkYjM5ZTcwMWM0MDA4NzJkYjdhNTk3NmY3IiwiZW1haWwiOiJndWlsaGVybWVAdGVzdGUuY29tLmJyIn0.ErA0h7WOYNnKnEoqmZH_0ajI7nI7BgdDY1U5lyxRXgw"
    },
    "cpf": "11111111111"
  }
}