Configurações da empresa

As configurações da empresa cliente ficam na seção Configurações da tela Perfil da empresa. Ela reúne a autenticação em duas etapas, a matrícula automática nas plataformas online, a permissão para alunos assinarem por texto, as solicitações de treinamento vindas do ERP e os padrões de assinatura digital.

Cada empresa tem um único conjunto de configurações. A chamada de gravação cria o conjunto na primeira vez e o altera nas seguintes.

Endpoints

Método	Caminho	Descrição
GET	/profiles/clients/parameters	Consulta as configurações da empresa
POST	/profiles/clients/parameters	Grava as configurações da empresa
PUT	/profiles/clients/parameters/{id}	Grava as configurações da empresa

GET /profiles/clients/parameters

Devolve as configurações da empresa. Se a empresa nunca salvou configurações, a resposta é null.

Resposta (200): o objeto das configurações, com os campos descritos abaixo.

POST /profiles/clients/parameters

Grava as configurações da empresa. Envie apenas os campos que quiser alterar. Os campos de nível superior que não forem enviados mantêm o valor atual. Em digital_signature_settings, o objeto enviado substitui o anterior por inteiro. Não há campos obrigatórios.

Corpo (JSON)

Campo	Obrigatório	Tipo	Descrição
two_factor_authentication	Não	Booleano	Autenticação em duas etapas. Quando ligada, o login pelo sistema pede um código enviado por e-mail, e também por SMS e WhatsApp quando houver celular. A obtenção de sessão pela API (login-by-token) não pede esse código
send_only_email	Não	Booleano	Com a autenticação em duas etapas ligada, envia o código somente por e-mail
auto_enroll_online_platform	Não	Booleano	Matricula alunos automaticamente nas plataformas online. Sem configuração salva, o padrão é ligado
allow_write_signature	Não	Booleano	Permite que os alunos assinem por texto
erp_training_request_enabled	Não	Booleano	Habilita as solicitações de treinamento vindas do ERP
digital_signature_settings	Não	Objeto	Padrões de assinatura digital para os novos documentos. Veja a tabela abaixo

Padrões de assinatura digital (digital_signature_settings)

Os padrões valem para os documentos cadastrados depois da alteração. Os documentos já cadastrados não mudam.

Campo	Obrigatório	Tipo	Descrição
requires_taxpayer_number	Não	Booleano	Exige a confirmação do CPF do destinatário
requires_two_factor	Não	Booleano	Autenticação de dois fatores na assinatura
requires_selfie	Não	Booleano	Solicita foto do documento e selfie
validity_months	Não	Inteiro (1 a 120)	Prazo de monitoramento, em meses
qr_code_position	Não	Texto	Posição do QR code de validação: none, top_left, top_right, bottom_left ou bottom_right
appends_certificate_to_signed_file	Não	Booleano	Inclui o comprovante de assinatura ao final do documento

Resposta (201): o objeto das configurações gravadas.

curl -X POST https://api.pedagogo.app/profiles/clients/parameters \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <token-de-sessao>" \
  -d '{
    "two_factor_authentication": true,
    "send_only_email": false,
    "auto_enroll_online_platform": true,
    "digital_signature_settings": {
      "requires_taxpayer_number": true,
      "validity_months": 12,
      "qr_code_position": "bottom_right"
    }
  }'

PUT /profiles/clients/parameters/{id}

Tem o mesmo corpo, as mesmas regras e a mesma resposta do POST. O {id} do caminho não é usado: a empresa é sempre a do usuário que fez a chamada.