Configuring REST API connection parameters

This section describes how to obtain the API public key and API private key for the REST API. Public and private keys are displayed in the rep properties screen in Tigerpaw. Rep records identify users in Tigerpaw. You can either create a new API rep or select an existing one for your integration.

To obtain REST API public and private keys:

  1. Start Tigerpaw.
  2. On the Tigerpaw main menu select EditMaster Tables.
  3. In the Table Maintenance window that opens, in the tree view expand RepAccount Reps.
  4. Select an existing account rep for your integration or create a new one.

    For more details about rep records, refer to the Tigerpaw documentation.

    The security role of the rep account that you select for your integration must provide enough rights to access all required Tigerpaw items. The items are:

    • Accounts (get, update).
    • Recurring agreements (get, create, update).
    • Master tables (get, create, update).
    • Price book items (get).
    • Service orders (get, create, update)
    • Custom folders and fields (get, create, update).
  5. View the properties of an existing account rep by double-clicking it in Rep Name column of the table, or create a new account rep for the REST API by clicking New on the toolbar in the Table Maintenance window.
  6. In the Account Rep Maintenance window that opens, click the Admin tab and in the REST API Security section view the public and private keys of the existing account rep or click the Generate button to create the public and private keys for a new account rep.
  7. Make a note of the public and private keys or copy them to the Clipboard. You will have to specify these keys when you configure integration with Tigerpaw.

Page top