Knowledge Base: App-Specific Help > HHC API
How do I setup Handheld Contact API?
Posted by Craig S, Last modified by Craig S on 29 August 2023 04:21 PM

This article will explain how to setup the new Handheld Contact API software.

Handheld Contact API uses the Act! Web API technology to securely access your contacts directly from your database. With this being said you will need your hosted Act! details in order to properly utilize Handheld Contact API.

Things to obtain/setup before you begin:

  1. Handheld Contact API will sync with 1 Act! Group for contacts. It is recommended to create this Group beforehand. For a detailed article please click here.
  2. Act! API URL - This is the server address to the Act! Web API where the main database resides. The correct address with end with 'Act.Web.API'. It is recommended to contact your hosting provider in order to obtain this address. However, if you are hosted with Keystroke, this address can be found here. Hosting with Act! Premium Cloud, the address can be found here.
  3. Act! Database Name - The name of the database that you will log into. Your hosting provider can also provide this.
  4. Act! Username/Password

Once the above items are collected, you may proceed with the Handheld Contact API setup:

iOS (iPhone/iPad): {Click here for visual representation of directions}

  1. Go to this page in order to create a new Handheld Contact API account.  Note: This cannot be the same username (email address) as an existing Handheld Contact Classic username.  If the same username is required, please CLICK HERE to disable the Classic account.
  2. After the account is created, verify the email address.  An email will be sent to the username with a link to click on.
  3. If you do not receive this email and need to resend it, please CLICK HERE.
  4. Once the email address is verified proceed to the Act! database.
  5. Handheld Contact API will synchronize using Act! Groups.  NOTE: ONLY 1 GROUP CAN BE SELECTED TO SYNC WITH.  Therefore, it is best to create this Group in advance.
  6. For additional assistance with Groups, please CLICK HERE for a video of creating custom Groups.
  7. CLICK HERE in order to download the Handheld Contact API software.  You can also visit www.handheldcontact.com/api from your device.
  8. Launch Handheld Contact API.
  9. If prompted by Apple: "'HHC Api' Would Like to Send You Notifications", choose 'Allow'.
  10. Enter the 'Act! server address url'.  Note: This address does not match your Act! for Web login URL.  It typically will end with 'act.web.api'.  If you do not have this address, please contact your Act! hosting provider.
  11. Enter the 'Act! database name' that is used to log into Act!.
  12. Enter your 'Act! username' and 'Act! password' (if you have one).
  13. Press 'LOGIN' button to continue.
  14. Enter the 'HHC username (email address)' as created from Step 1 above.  As well as the 'HHC password'.
  15. Press 'LOGIN' button to continue.
  16. Choose the Group to sync with.  This may be the same Group from Step 5/6 above.
  17. Press Next.
  18. A list of custom fields (from the database in Step 11) will appear.  If any additional custom fields are to be synced, toggle them ON.
  19. Press Next.
  20. To enable Opportunities, toggle the switch ON.  Note: Handheld Contact API will download only Open Opportunities by default.  To get all status types, toggle 'Open Opportunities' OFF.
  21. Press Next.
  22. Begin the initial download by pressing the 'START DOWNLOAD' button.
  23. When the download is completed, press Next to be taken to the Handheld Contact API Dashboard.

Android:  {Click here for visual representation of directions}

  1. Go to this page in order to create a new Handheld Contact API account.  Note: This cannot be the same username (email address) as an existing Handheld Contact Classic username.  If the same username is required, please CLICK HERE to disable the Classic account.
  2. After the account is created, verify the email address.  An email will be sent to the username with a link to click on.
  3. If you do not receive this email and need to resend it, please CLICK HERE.
  4. Once the email address is verified proceed to the Act! database.
  5. Handheld Contact API will synchronize using Act! Groups.  NOTE: ONLY 1 GROUP CAN BE SELECTED TO SYNC WITH.  Therefore, it is best to create this Group in advance.
  6. For additional assistance with Groups, please CLICK HERE for a video of creating custom Groups.
  7. CLICK HERE in order to download the Handheld Contact API software.  You can also visit www.handheldcontact.com/api from your device.
  8. Launch Handheld Contact API.
  9. If prompted by Android to allow permissions, choose Yes for all popups.
  10. Enter the 'Act! server address url'. Note: This address does not match your Act! for Web login URL. It typically will end with 'act.web.api'. If you do not have this address, please contact your Act! hosting provider or CLICK HERE for more information.
  11. Enter the 'Act! database name' that is used to log into Act!.
  12. Enter your 'Act! username' and 'Act! password' (if you have one).
  13. Press the 'LOGIN' button to continue.
  14. Enter the 'HHC username (email address)' as well as the 'HHC password'.
  15. Press 'SIGN IN' button to continue.
  16. Choose the Group to sync with. If you created the Group while Handheld Contact was open, press ‘REFRESH’ button to find the new Group.
  17. Press ‘CONTINUE’.
  18. A list of standard mapped fields will appear. If any additional custom fields are to be synced, move to the ‘Map custom fields’ section. Tap on ‘Do not map’ dropdown and select the required field. Repeat until all fields needed are mapped.
  19. Press ‘CONTINUE’.
  20. To enable Opportunities, toggle the top box ON. Note: Handheld Contact API will download only Open Opportunities by default. To get all status types, toggle 'Open Only' OFF.
  21. If adding any custom opportunity fields, tap on ‘Do not map’ dropdown and select the required field.
  22. Press ‘CONTINUE’.
  23. Begin the initial download by selecting ‘Now’ button and pressing the 'START DOWNLOAD' button.
  24. When the download is completed, press the device's 'Back' button to return to the Dashboard view.