Skip to content

Usuários

bling_erp_api.resources.usuarios.UsuariosResource 

UsuariosResource(transport: Transport)

Bases: BaseResource

Usuarios API resource. Maps to /usuarios endpoints.

Provides password recovery and hash verification endpoints for Bling API user management. Canonical methods are in pt-BR following the official Bling documentation; English aliases are available for compatibility.

Source code in src/bling_erp_api/resources/base.py 
141
142
143
def __init__(self, transport: Transport) -> None:
    """Create a resource bound to a transport."""
    self._transport = transport

recuperar_senha 

recuperar_senha(email: str) -> JsonObject

Solicita a recuperação de senha por email.

Endpoint: POST /usuarios/recuperar-senha

Envia uma solicitação de recuperação de senha para o email informado. O email deve pertencer a um usuário cadastrado no sistema.

Parameters:

Name Type Description Default
email str

Email do usuário para recuperação de senha (Bling: email, string, obrigatório)

 required

Returns:

Name Type Description
JsonObject

Bling API response. Response schemas: 200: UsuariosRecuperarSenhaPostResponse200;
400 JsonObject

ErrorResponse; 404: ErrorResponse
Source code in src/bling_erp_api/resources/usuarios.py 
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
def recuperar_senha(self, email: str) -> JsonObject:
    """Solicita a recuperação de senha por email.

    Endpoint: POST /usuarios/recuperar-senha

    Envia uma solicitação de recuperação de senha para o email informado.
    O email deve pertencer a um usuário cadastrado no sistema.

    Args:
        email: Email do usuário para recuperação de senha
            (Bling: ``email``, string, obrigatório)

    Returns:
        Bling API response. Response schemas: 200: UsuariosRecuperarSenhaPostResponse200;
        400: ErrorResponse; 404: ErrorResponse
    """
    return self._post(
        f"{self.BASE_PATH}/recuperar-senha",
        json={"email": email},
    )

redefinir_senha 

redefinir_senha(hash_value: str, password: str) -> JsonObject

Redefine a senha usando o hash de recuperação.

Endpoint: PATCH /usuarios/redefinir-senha

Redefine a senha do usuário utilizando o hash recebido por email durante o processo de recuperação de senha.

Parameters:

Name Type Description Default
hash_value str

Hash de recuperação enviado por email (Bling: hash, string, obrigatório)

 required
password str

Nova senha do usuário (Bling: password, string, obrigatório)

 required

Returns:

Name Type Description
JsonObject

Bling API response. Response schemas: 200: JsonObject; 400: ErrorResponse;
404 JsonObject

ErrorResponse
Source code in src/bling_erp_api/resources/usuarios.py 
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
def redefinir_senha(self, hash_value: str, password: str) -> JsonObject:
    """Redefine a senha usando o hash de recuperação.

    Endpoint: PATCH /usuarios/redefinir-senha

    Redefine a senha do usuário utilizando o hash recebido por email
    durante o processo de recuperação de senha.

    Args:
        hash_value: Hash de recuperação enviado por email
            (Bling: ``hash``, string, obrigatório)
        password: Nova senha do usuário
            (Bling: ``password``, string, obrigatório)

    Returns:
        Bling API response. Response schemas: 200: JsonObject; 400: ErrorResponse;
        404: ErrorResponse
    """
    return self._patch(
        f"{self.BASE_PATH}/redefinir-senha",
        json={"hash": hash_value, "password": password},
    )

verificar_hash 

verificar_hash(hash_value: str) -> JsonObject

Verifica se um hash de recuperação é válido.

Endpoint: GET /usuarios/verificar-hash

Verifica se um hash de recuperação de senha ainda é válido e não expirou.

Parameters:

Name Type Description Default
hash_value str

Hash de recuperação a ser verificado (Bling: hash, string, obrigatório)

 required

Returns:

Name Type Description
JsonObject

Bling API response. Response schemas: 200: UsuariosVerificarHashGetResponse200;
400 JsonObject

ErrorResponse; 404: ErrorResponse
Source code in src/bling_erp_api/resources/usuarios.py 
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
def verificar_hash(self, hash_value: str) -> JsonObject:
    """Verifica se um hash de recuperação é válido.

    Endpoint: GET /usuarios/verificar-hash

    Verifica se um hash de recuperação de senha ainda é válido e não
    expirou.

    Args:
        hash_value: Hash de recuperação a ser verificado
            (Bling: ``hash``, string, obrigatório)

    Returns:
        Bling API response. Response schemas: 200: UsuariosVerificarHashGetResponse200;
        400: ErrorResponse; 404: ErrorResponse
    """
    return self._get(
        f"{self.BASE_PATH}/verificar-hash",
        params={"hash": hash_value},
    )

recover_password 

recover_password(email: str) -> JsonObject

Compatibility alias for recuperar_senha().

Solicita a recuperação de senha por email.

Endpoint: POST /usuarios/recuperar-senha

Envia uma solicitação de recuperação de senha para o email informado.

Parameters:

Name Type Description Default
email str

Email do usuário para recuperação de senha (Bling: email, string, obrigatório)

 required

Returns:

Name Type Description
JsonObject

Bling API response. Response schemas: 200: UsuariosRecuperarSenhaPostResponse200;
400 JsonObject

ErrorResponse; 404: ErrorResponse
Source code in src/bling_erp_api/resources/usuarios.py 
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
def recover_password(self, email: str) -> JsonObject:
    """Compatibility alias for ``recuperar_senha()``.

    Solicita a recuperação de senha por email.

    Endpoint: POST /usuarios/recuperar-senha

    Envia uma solicitação de recuperação de senha para o email informado.

    Args:
        email: Email do usuário para recuperação de senha
            (Bling: ``email``, string, obrigatório)

    Returns:
        Bling API response. Response schemas: 200: UsuariosRecuperarSenhaPostResponse200;
        400: ErrorResponse; 404: ErrorResponse
    """
    return self.recuperar_senha(email=email)

reset_password 

reset_password(hash_value: str, password: str) -> JsonObject

Compatibility alias for redefinir_senha().

Redefine a senha usando o hash de recuperação.

Endpoint: PATCH /usuarios/redefinir-senha

Redefine a senha do usuário utilizando o hash recebido por email durante o processo de recuperação de senha.

Parameters:

Name Type Description Default
hash_value str

Hash de recuperação enviado por email (Bling: hash, string, obrigatório)

 required
password str

Nova senha do usuário (Bling: password, string, obrigatório)

 required

Returns:

Name Type Description
JsonObject

Bling API response. Response schemas: 200: JsonObject; 400: ErrorResponse;
404 JsonObject

ErrorResponse
Source code in src/bling_erp_api/resources/usuarios.py 
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
def reset_password(self, hash_value: str, password: str) -> JsonObject:
    """Compatibility alias for ``redefinir_senha()``.

    Redefine a senha usando o hash de recuperação.

    Endpoint: PATCH /usuarios/redefinir-senha

    Redefine a senha do usuário utilizando o hash recebido por email
    durante o processo de recuperação de senha.

    Args:
        hash_value: Hash de recuperação enviado por email
            (Bling: ``hash``, string, obrigatório)
        password: Nova senha do usuário
            (Bling: ``password``, string, obrigatório)

    Returns:
        Bling API response. Response schemas: 200: JsonObject; 400: ErrorResponse;
        404: ErrorResponse
    """
    return self.redefinir_senha(hash_value=hash_value, password=password)

verify_hash 

verify_hash(hash_value: str) -> JsonObject

Compatibility alias for verificar_hash().

Verifica se um hash de recuperação é válido.

Endpoint: GET /usuarios/verificar-hash

Verifica se um hash de recuperação de senha ainda é válido e não expirou.

Parameters:

Name Type Description Default
hash_value str

Hash de recuperação a ser verificado (Bling: hash, string, obrigatório)

 required

Returns:

Name Type Description
JsonObject

Bling API response. Response schemas: 200: UsuariosVerificarHashGetResponse200;
400 JsonObject

ErrorResponse; 404: ErrorResponse
Source code in src/bling_erp_api/resources/usuarios.py 
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
def verify_hash(self, hash_value: str) -> JsonObject:
    """Compatibility alias for ``verificar_hash()``.

    Verifica se um hash de recuperação é válido.

    Endpoint: GET /usuarios/verificar-hash

    Verifica se um hash de recuperação de senha ainda é válido e não
    expirou.

    Args:
        hash_value: Hash de recuperação a ser verificado
            (Bling: ``hash``, string, obrigatório)

    Returns:
        Bling API response. Response schemas: 200: UsuariosVerificarHashGetResponse200;
        400: ErrorResponse; 404: ErrorResponse
    """
    return self.verificar_hash(hash_value=hash_value)