Open topic with navigation

Grant Users Access to the API

Before a user can call the API, they must have the following user settings:

• The appropriate FinancialForce API Apex classes must be enabled on their user profile.
• They must have access to the Salesforce API.
• A valid FinancialForce API license key must be set on their user details.

Note

The "Company service" does not require an API license key to be called.

To enable the API Apex classes:

1. Click Setup | Manage Users | Profiles.
2. Click the name of the relevant profile.
3. Scroll to the Enabled Apex Class Access section.
4. Click Edit.
5. Enable following the Apex classes. It may be useful to use the Apex Class Views that you have created. See "Creating an API Apex Class View" for more details.

   CODAAPIBankStatement_6_0

   CODAAPICashEntry_6_0

   CODAAPICashMatching_6_0

   CODAAPIIntegrationRule_6_0

   CODAAPIJournal_6_0

   CODAAPIPurchaseCreditNote_6_0

   CODAAPIPurchaseInvoice_6_0

   CODAAPISalesCreditNote_6_0

   CODAAPISalesInvoice_6_0

   CODAAPIBudget_5_0

   CODAAPIIntercompanyTransfer_4_0

   CODAAPIDimension_3_0

   CODAAPIGeneralLedgerAccount_3_0

   CODAAPIPrintFormat_3_0

   CODAAPISelector_3_0

   CODAAPICompany_2_0

   CODAAPIMappingFormat_2_0

6. If people with this user profile need access to the FinancialForce Version 5.x API, also enable the following Apex Classes:

   CODAAPIJournal_5_0

   CODAAPIPurchaseCreditNote_5_0

   CODAAPIPurchaseInvoice_5_0

   CODAAPISalesCreditNote_5_0

   CODAAPICashEntry_5_0

7. If people with this user profile need access to the FinancialForce Version 4.x API, also enable the following Apex Classes:

   CODAAPIJournal_4_0

   CODAAPIPurchaseCreditNote_4_0

   CODAAPIPurchaseInvoice_4_0

   CODAAPISalesCreditNote_4_0

   CODAAPIBudget_4_0

   CODAAPICashEntry_4_0

8. If people with this user profile need access to the FinancialForce Version 3.x API, also enable the following Apex Classes:

   CODAAPIIntegrationRule_3_0

   CODAAPIJournal_3_0

   CODAAPIPurchaseCreditNote_3_0

   CODAAPIPurchaseInvoice_3_0

   CODAAPISalesCreditNote_3_0

   CODAAPISalesInvoice_3_0

7. Click Save.
8. Repeat for all other relevant profiles.

To grant a user access to the Salesforce API:

1. Click Setup | Manage Users | Profiles.
2. Click Edit next to the name of the relevant profile.
3. Scroll down to the Administrative Permissions section.
4. If necessary, set the API Enabled check box.
5. Click Save.

To set a user's FinancialForce API license key:

1. Click Setup | Manage Users | Users.
2. Click Edit next to a user's name.
3. Open your email client and find the email message that you received from the FinancialForce Licensing & Distribution Department.
4. Copy the license key token to your computer's clipboard.
5. Return to the user edit page and paste the license key token into the API License Key field.
6. Click Save.

See the Salesforce Help for more information.

© Copyright 2009-2012 FinancialForce.com, inc. All rights reserved.
Various trademarks held by their respective owners.