Autenticación

Para hacer uso de la aplicación de Pagando Check Services es necesario contar con las credenciales otorgadas por Pagando Check, si aún no cuentas con credenciales puedes contactarte con un asesor de ventas

Las credenciales permiten la generación de un token de sesión interno usado para verificar las operaciones.

Este token tiene un tiempo de vida de 24 horas y la aplicación cliente es la encargada de solicitar nuevamente la generación de un nuevo token pasado este tiempo de vida. Una vez generado, la aplicación de Pagando Check Services configura el token para su uso en futuras operaciones.

Inicio de sesión (Credenciales Pagando Check)

La función login permite la autenticación por medio de las credenciales especificadas para un usuario de Pagando Check (usuario y contraseña).

Parámetros

• email: String
  • Descripción: El correo o número de teléfono del usuario registrado en Pagando Check que inicia sesión
  • Ejemplo: "usuario@example.com"
• password: String
  • Descripción: La contraseña asociada con el usuario proporcionado. Debe ser tratada de manera segura y nunca debe ser expuesta o impresa en la consola.
  • Ejemplo: "contraseñaSegura123"

Callback: LoginCallback

• Descripción: Callback utilizado para recibir los resultados del intento de inicio de sesión.
• Métodos:
  • onSuccessful: Este método se invoca cuando el inicio de sesión es exitoso.
    • Descripción: Se llama cuando el inicio de sesión se completa exitosamente.
    • Retorno: No retorna un valor, pero indica que el proceso de inicio de sesión fue exitoso.
  • onError: Este método se invoca cuando ocurre un error durante el intento de inicio de sesión.
    • Parámetros:
      • error (ErrorResponse): Un código y mensaje de error opcional que describe el fallo.
        • code código de error
        • message mensaje de error
    • Descripción: Se llama cuando hay un error en el proceso de inicio de sesión.
    • Retorno: No retorna un valor, pero proporciona información sobre el error ocurrido.

/*
Declara una variable de solo lectura llamada 
checkServices de tipo CheckServices y le asigna 
la instancia de CheckServices obtenida mediante 
el llamado al método getInstance(context).
*/

val checkServices: CheckServices = CheckServices.getInstance(context)

/*
Llamada de la función login que recibe como parametro emial y password
responde un LoginCallback que podría tener dos metodos: onSuccesfull y onError
*/
checkServices.login(email, password,
      object : LoginCallback.Stub() {
          override fun onSuccessful() {
						// Avanzar a siguiente pantalla 

          }

          override fun onError(error: ErrorResponse) {
              Log.e("error", error.code)
          }
      })

/*
Declara una variable de solo lectura llamada 
checkServices de tipo CheckServices y le asigna 
la instancia de CheckServices obtenida mediante 
*/        
CheckServices checkServices = CheckServices.getInstance(this);

/*
Llamada de la función login que recibe como parametro emial y password
responde un LoginCallback que podría tener dos metodos: onSuccesfull y onError
*/
        checkServices.login(email, password, new LoginCallback.Stub() {
            @Override
            public void onSuccessful() {
							// Avanzar a siguiente pantalla 
            }

            @Override
            public void onError(ErrorResponse error) {
                Log.d("error", error.code);
            }
        });

Autenticación API (Credenciales Pagando Check)

La función loginApi habilita la autenticación a través de una llave de aplicación y una cookie para usuarios del sistema Pagando Check.

Parámetros

• key: String
  • Descripción: La llave de aplicación proporcionada al desarrollador o usuario autorizado para utilizar los servicios de Pagando Check.
  • Ejemplo: "llaveDeAplicacion123"
• cookie: String
  • Descripción: Una cookie de sesión válida que identifica la sesión actual del usuario con el servidor. Utilizada para mantener la sesión autenticada entre las solicitudes.
  • Ejemplo: "cookieDeSesionValida"
• SandboxMode: boolean
  • Descripción: una bandera booleana que define si las peticiones se dirigen a un entorno de pruebas
  • Si es true se accede al ambiente de pruebas
  • Si es false se mandan a los servidores de producción
  • Ejemplo: "cookieDeSesionValida"

Callback: LoginCallback

• Descripción: Callback utilizado para manejar las respuestas resultantes del intento de autenticación con la API.
• Métodos:
  • onSuccessful: Este método se convoca cuando la autenticación con la API es exitosa.
    • Descripción: Invocado tras una autenticación exitosa con la API.
    • Retorno: No retorna un valor, indica que la autenticación fue exitosa.
  • onError: Este método se convoca cuando ocurre un error durante el intento de autenticación con la API.
    • Parámetros:
      • error (ErrorResponse): Un código y mensaje de error opcional que describe el fallo.
        • code código de error
        • message mensaje de error
    • Descripción: Invocado cuando hay un error en el proceso de autenticación con la API.
    • Retorno: No retorna un valor, pero proporciona detalles sobre el error ocurrido.

/*
Llamada de la función loginApi que recibe como parámetros key y cookie, 
y responde un LoginCallback que podría tener dos métodos: onSuccessful y onError.
*/
checkServices?.loginApi(key, cookie,
      object : LoginCallback.Stub() {
          override fun onSuccessful() {
              // Acciones a realizar tras una autenticación exitosa
          }

          override fun onError(error: ErrorResponse) {
              Log.e("error", error.code)
          }
      })

        CheckServices checkServices = CheckServices.getInstance(this);

        checkServices.loginApi(email, password, new LoginCallback.Stub() {
            @Override
            public void onSuccessful() {
                Log.d("SuccessFull", "SuccessFull");
            }

            @Override
            public void onError(ErrorResponse error) {
                Log.d("LoginApi", error.code );
            }
        });

Cierre de Sesión

La función logout permite a los usuarios cerrar sesión de forma segura en el sistema Pagando Check. Al invocarse, realiza las operaciones necesarias para desvincular la sesión actual del usuario y, opcionalmente, limpiar datos locales relacionados con la sesión.

Callback: LogoutCallback

• Descripción: Callback utilizado para manejar el resultado del intento de cierre de sesión.
• Métodos:
  • onSuccessful: Este método se invoca cuando el cierre de sesión es exitoso.
    • Descripción: Se llama tras un cierre de sesión exitoso, realizando operaciones de limpieza como borrar las preferencias compartidas y redirigir al usuario a la pantalla principal.
    • Operaciones:
      • Limpieza de preferencias compartidas: Borra todas las preferencias guardadas relacionadas con la sesión del usuario.
      • Redirección al inicio: Redirige al usuario a la pantalla principal de la aplicación, reiniciando la tarea y limpiando el historial de navegación.
    • Retorno: No retorna un valor, pero efectúa las operaciones de limpieza y redirección necesarias tras un cierre de sesión exitoso.
  • onError: Este método se invoca cuando ocurre un error durante el intento de cierre de sesión.
    • Parámetros:
      • error (ErrorResponse): Un código y mensaje de error opcional que describe el fallo.
      • code código de error
      • message mensaje de error
    • Descripción: Se llama cuando hay un error en el proceso de cierre de sesión.
    • Retorno: No retorna un valor, pero proporciona un punto de extensión para manejar errores específicos relacionados con el cierre de sesión.

checkServices.logout(object : LogoutCallback.Stub() {
                                override fun onSuccessful() {
// Logout exitoso
                                }

										          override fun onError(error: ErrorResponse) {
										              Log.e("error", error.code)
										          }
                            })

CheckServices checkServices = CheckServices.getInstance(this);
        
checkServices.logout( new LogoutCallback.Stub() {
            
	@Override            
	public void onSuccessful() throws RemoteException {
		// Logout exitoso
	}

  @Override
	public void onError(ErrorResponse error) throws RemoteException {
		// Ocurrio un error al hacer logout 
    Log.e("LogoutError", error.code)  
    }
});