Configuring GSX User Credentials in PIMS

Configuring GSX User Credentials in PIMS

Overview

With the launch of the RESTful GSX APIs, Apple changed authentication to a user-based tokenized system.  Rather than have a PIMS Administrator manage the credentials for all GSX users, ExecUtron added the ability for each user to manage their own credentials within PIMS.  If users who have previously set up their GSX Credentials in PIMS are receiving an "Unauthorized" error from GSX within PIMS, it's a good idea to go through the steps to obtain a new API Token to replace the existing one in PIMS.

Step-by-Step Walkthrough

  1. GSX User Credentials can be accessed from any Service & Repair Order (SRO) Record.  To get started, open the Service & Repair Module and open any existing SRO or create a new SRO.

  2. At the bottom of the "SRO Entry" window, click on the button labeled "GSX Repair Functions".


  3. A list of available GSX Functions will be displayed, click on the button labeled "View Tech Credentials" at the bottom-left of the listing.




  4. PIMS will prompt the you to enter the employee code of the user they would like to update GSX credentials for.  Enter your PIMS employee code and click the "OK" button.




  5. PIMS will display the "GSX 2.0 CREDENTIALS" entry screen.

  6. Enter the Apple ID and Apple ID password you use to login to GSX into the fields labeled "APPLE ID" and "ID PASSWORD".




  7. If you have an Apple Tech ID, enter this into the field labeled "TECH ID".  (If you do not have an Apple Tech ID, you can leave this field blank.  It is only required for creating repairs.)




  8. Fill in the API TOKEN field with your GSX API Token.  To obtain a token follow the steps below.




    1. Click on the link below the "API TOKEN" field to visit the GSX API Token page or manually input https://login-partner-connect.apple.com/api/login your browser's URL bar.




    2. Once the page loads in your browser, log in with your GSX Apple ID and password.

    3. Once you have logged in, you will be presented with a page that contains your GSX API Token.  Click the button labeled "Copy to clipboard" to put the API Token on your clipboard.


      If you are unable to obtain an API token after logging in to this page, this means that there is a problem with your GSX Apple ID.  Please perform the following steps to resolve the issue.
      1. Verify with your GSX Administrator that your GSX Apple ID has the appropriate privileges to access the GSX APIs—in particular, you must have the "Web Services" privilege assigned to your Apple ID in MyAccess (https://myaccess.apple.com/).
      2. You may be using an Apple ID with an Apple ID Type that is no longer supported when moving to the GSX RESTful APIs.  If this is the case, please follow the instructions in GSX article OP1474 to "Disassociate your corporate email address from the existing Apple ID" or to "Create a new Apple ID, compatible with GSX".  (More information about GSX-compatible Apple IDs can be found in the "Frequently Asked Questions" section of GSX Article OP1891.)

    4. Once the API Token is on the clipboard, we recommend closing the GSX API Token page window in your browser.  If you accidentally refresh the page, Apple will generate a new API token for your account and any previous API Tokens associated with your Apple ID will be invalidated.

    5. Paste the API TOKEN into the "API TOKEN" field on on the "GSX 2.0 CREDENTIALS" entry screen in PIMS.




  9. Once you have filled in your API Token, click the "Test" button to the right of the "AUTH TOKEN" field to obtain an Authorization Token from GSX.




  10. If an Authorization Token is successfully returned, you will receive a message stating "Your Successful Token Was Returned" and the Authorization Token will be populated into the "AUTH TOKEN" field.




  11. Once you have successfully obtained an Authorization Token, click the "Save" button at the bottom-right of the "GSX 2.0 CREDENTIALS" entry screen to save your GSX User Credentials, API Token, & Authorization Token and return to the "Available GSX 2.0 Functions" window.




  12. Click "Cancel" at the bottom-center of the "Available GSX 2.0 Functions" window to return to the SRO Record.




  13. You may close the SRO Record by clicking either the "Save" or "Cancel" buttons at the bottom-left of the window.  It is not necessary to save the SRO Record to save your GSX credentials as they were already saved in the steps above.  The only reason you may want to save the SRO Record is if you made changes to the record itself.

    • Related Articles

    • Giving GSX Users API Privileges in MyAccess

      Overview In order to make use of the GSX API integration in PIMS, all users must be given a minimum role of "Technician" with the optional privilege of "Web Services" selected.  This article details how to verify that users have the correct role and ...
    • PIMS GSX API Integration

      Since Apple's announcement that their SOAP API's were going offline, there's been a lot of discussion as to what options are available to Apple Authorized Service Providers. We believe that the best option is one which takes advantage of the new REST ...
    • Updating your GSX API Token for Weevio Scheduler & Notifier

      Overview With the launch of the RESTful GSX APIs, Apple changed authentication to a user-based tokenized system. Starting May 31, 2022, GSX Web Services will limit the maximum duration of token exchanges that may be performed through the token API. ...
    • Install the PIMS-Platinum Client Application on a Mac

      Overview In a server-client installation of PIMS, users will access and interact with PIMS using the PIMS Client application. Below are the instructions on how to download and install the PIMS-Platinum Client application. Step-by-Step Walkthrough If ...
    • GSX Integration Onboarding for Weevio Notifier & Scheduler

      Overview Apple uses a complex and highly secure authentication system for their APIs.  This system requires the exchanging of authentication tokens throughout the process of making API calls.  Failure to provide the most recent token during an API ...