Empresa cliente
Os dados cadastrais da empresa cliente do usuário, a logo e as integrações vinculadas à empresa. Correspondem à tela Perfil da empresa. O logo cadastrado aparece no cabeçalho dos PDF gerados pelo sistema.
Endpoints
| Método | Caminho | Descrição |
|---|---|---|
| GET | /profiles/clients | Consulta os dados da empresa cliente |
| POST | /profiles/clients/logo | Envia a logo da empresa |
| GET | /profiles/clients/integrations | Lista as integrações vinculadas à empresa |
GET /profiles/clients
Devolve os dados cadastrais da empresa cliente do usuário que fez a chamada.
Resposta (200): o objeto da empresa cliente.
POST /profiles/clients/logo
Envia a logo da empresa. A logo substitui a anterior.
Corpo (multipart/form-data)
| Campo | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| file | Sim | Imagem | Imagem da logo |
Resposta (200): o objeto da empresa cliente, já com a nova logo.
curl -X POST https://api.pedagogo.app/profiles/clients/logo \
-H "Accept: application/json" \
-H "Authorization: Bearer <token-de-sessao>" \
-F "file=@./logo-exemplo.png"
GET /profiles/clients/integrations
Lista as integrações vinculadas à empresa, com a indicação de se estão ativas. A tela de configurações mostra a matrícula automática apenas para empresas com uma integração de plataforma online ativa.
Parâmetros de URL
| Parâmetro | Obrigatório | Descrição |
|---|---|---|
| search | Não | Trecho do nome da integração |
| per_page | Não | Quantidade de registros por página. Sem ele, a resposta é a lista simples |
| page | Não | Número da página, quando per_page é informado |
Resposta (200): lista de integrações, com integration_id, integration_name
(nome da integração) e is_active (se a integração está ativa para a empresa).