# API: Auth --- - [Login](#login) - [Logout](#logout) - [Inicia Recuperação de Senha](#password_recovery) - [Valida Token](#validate_token) - [Update Password](#update_password) - [Who am I](#whoami) ## Login ### Endpoint |Método|URI|Headers| |:|:-|:| |POST|`/auth/login`|Default| ### Body ```json { "username": "admin", "password": "admin123" } ``` ### Responses 200 - OK ```json { "user": { "id": , "empresa_id": , "name": , "username": , "email": , "cpf": , "email_verified_at": , "is_active": bool, "is_criar": bool, "empresa": { "id": , "cnpj": , "razao_social": , "nome_fantasia": , "email": , "logo_file": , "is_active": bool, "assinatura_contrato_at": , "phones": [ { "number": , "is_mobile": bool, "has_whatsapp": bool } ] }, "full_address": , "phones": [ { "number": , "is_mobile": bool, "has_whatsapp": bool } ], "roles": [], "permissions": [] }, "token": } ``` 401 - Unauthorized ```json { "message": "Essas credenciais não correspondem aos nossos registros." } ``` ## Logout ### Endpoint | Método|URI|Headers| |:|:-|:| |POST| `/auth/logout` | Default | ### Body ```json Empty ``` ### Responses 200 - OK ```json { "message": "Desconectado com sucesso." } ``` 401 - Unauthorized ```json { "message": "Unauthenticated." } ``` ## Inicia Recuperação de Senha ### Endpoint | Método|URI|Headers| |:|:-|:| |POST| `/auth/password-recover/start` | Default | ### Body ```json { "username": "admin" } ``` ### Responses 200 - OK ```json { "message": "Um email para recuperação de senha foi enviado.", "url": "/api/auth/password-recover/url/{hash}?expires={axpires}&signature={signature}" } ``` 401 - Unauthorized ```json { "message": "Usuário CRIAR não pode alterar a senha." } ``` ```json { "message": "Essas credenciais não correspondem aos nossos registros." } ``` ## Valida Token ### Endpoint | Método|URI|Headers| |:|:-|:| |POST| `/auth/password-recover/url/?expires=&signature=` | Default | ### Body ```json { "token": } ``` ### Responses 200 - OK ```json { "url": "/api/auth/password-recover/update/?expires=&signature=" } ``` 422 - Unprocessable Content ```json { "message": "Invalid or expired token." } ``` 403 - Forbidden ```json { "message": "Invalid signature." } ``` ## Update Password ### Endpoint | Método|URI|Headers| |:|:-|:| |POST| `/auth/password-recover/url/?expires=&signature=` | Default | ### Body ```json { "password": "12345678", "password_confirmation": "12345678" } ``` ### Responses 200 - OK ```json { "message": "Senha atualizada com sucesso!" } ``` ## Who am i ### Endpoint | Método|URI|Headers| |:|:-|:| |POST| `/auth/whoami` | Default | ### Body ```json Empty ``` ### Responses 200 - OK ```json { "id": , "empresa_id": , "name": , "username": , "email": , "cpf": , "email_verified_at": , "is_active": , "is_criar": , "full_address": , "phones": [], "permissions": [] } ``` 401 - Unauthorized ```json { "message": "Unauthenticated." } ```