Pular para o conteúdo principal

Meu perfil

Os dados do próprio usuário: celular, foto e senha. Correspondem ao Meu perfil, no menu do avatar, no canto superior da tela. Por esta API, cada chamada atua apenas sobre o usuário do token.

Endpoints​

MétodoCaminhoDescrição
GET/profiles/usersConsulta o usuário logado
PUT/profiles/usersAltera o celular do usuário logado
POST/profiles/users/photoEnvia a foto do usuário logado
GET/profiles/users/photo/{key}Baixa uma foto de usuário
POST/profiles/users/reset-passwordAltera a senha do usuário logado

GET /profiles/users​

Devolve o usuário logado, com os dados da empresa cliente, os pacotes da empresa e as integrações da empresa, com is_active.

Resposta (200): o objeto do usuário.

PUT /profiles/users​

Altera o celular do usuário logado.

Corpo (JSON)

CampoObrigatórioTipoDescrição
cellphoneSimTextoCelular do usuário

Resposta (200): o objeto do usuário alterado.

POST /profiles/users/photo​

Envia a foto do usuário logado. A foto substitui a anterior.

Corpo (multipart/form-data)

CampoObrigatórioTipoDescrição
photoSimImagemFoto do usuário

Resposta (200): o objeto do usuário, com a foto atualizada.

GET /profiles/users/photo/{key}​

Baixa a foto de um usuário. O key é o uuid da foto, que aparece no campo photo.uuid do usuário.

Parâmetros de URL

ParâmetroObrigatórioDescrição
keySimIdentificador (uuid) da foto

Resposta (200): a imagem, com o tipo de conteúdo da foto. Sem foto, a resposta é 204, sem corpo.

POST /profiles/users/reset-password​

Altera a senha do usuário logado. A senha precisa ter pelo menos 8 caracteres e ser confirmada.

Corpo (JSON)

CampoObrigatórioTipoDescrição
old_passwordSimTextoSenha atual
passwordSimTextoNova senha. Mínimo de 8 caracteres
password_confirmationSimTextoConfirmação da nova senha. Deve ser igual a password

Resposta (200): {"status": "Password changed!"}.

Erros

StatusCorpoQuando acontece
401{"error": "Invalid password."}A senha atual não confere
curl -X POST https://api.pedagogo.app/profiles/users/reset-password \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer <token-de-sessao>" \
-d '{"old_password": "<senha-atual>", "password": "<nova-senha>", "password_confirmation": "<nova-senha>"}'