Chapter 2: Authentication

After you integrate GaragePro android SDK into your project, and your gradle sync is complete, first step is to authenticate this SDK using some unique identifiers and pass token.

We recommend that you complete this authentication function as soon as the user is signed in to the application, or before the user is allowed to perform the scan or clear process. Every other function in this SDK will fail, if this authentication step is not completed or failed.

Step 1: Instantiate 'GProAuthentication' class

Context context = <YourActivity>.this;
String uniqueIdentifier = <Phone Number> or <Email ID>;
String garageId = <Unique Garage Identifier>;
String userId = <Unique User Identifier>;
String passToken = <Pass Token as generated by CaRPM>;
GProAuthentication gProAuthentication = new GProAuthentication(context, uniqueIdentifier, garageId, userId, passToken); 

All the parameters required to instantiate 'GProAuthentication' class -

1. Context -> Pass the activity context in which this class is instantiated and used.
2. Unique Identifier -> This unique identifier can be either phone number or email ID of the said user, who is using the android application in which this SDK is integrated.
3. Garage ID (Optional) -> This ID is used to identify which garage is using this SDK, to better identify the scan and clear process data and reports. This ID is optional, you can pass 'null' if there is no Garage ID available.
4. User ID (Optional) -> This ID is used to identify which mechanic/technician is using this SDK in a garage, to better identify the scan and clear process data and reports, and to identify the roles and usage statistics of the user. This ID is optional, you can pass 'null' if there is no User ID available.
5. Pass Token -> This pass token is generated by CaRPM, and is passed to you separately.

NOTE - Please contact us for further information about this pass token at fix@carpm.in.

Step 2: Call 'init()' function

gProAuthentication.init();

The 'init()' function checks the authentication of the user and pass token, and creates a login session for the user. After the function is completed, results are passed onto the callback functions.

Step 3: Implement 'GProAuthenticationListener' Listener

public class YourActivity extends AppCompatActivity implements GProAuthenticationListener {
    ....
    ...
    
    @Override
    public void onAuthenticationSuccess(String message) {
        Log.d(TAG, "Authentication success: " + message);
        // You can start your scan and clear codes process, as and when required.
    }

    @Override
    public void onAuthenticationFailure(String message) {
        Log.e(TAG, "Authentication failure: " + message);
        // Write your logic to re-instantiate and recall the init() function of GProAuthentication class, 
        // because all your functions will fail if the authentication is not successfully completed.
    }
}

NOTE - If for any reason, the SDK authentication has failed multiple times, please contact us at fix@carpm.in with the parameters (except the pass token) used to instantiate the GProAuthenticationListener class.