1. API
  2. XML API and SOAP API
  3. API Best Practice Guidelines
  4. Maintain the API Integration

Maintain the API Integration

Before you use your API integration, there are two additional tasks to perform: set up the storage of communication logs and determine a process for upgrading the SuiteProjects Pro system. Each is explained as follows.

Store Communication Logs

In the event of an API integration error, your SuiteProjects Pro Professional Services consultant or SuiteProjects Pro Support can help you troubleshoot the error. To do so, you need to be able to provide them with both the request code and associated response. Store a log of recent API communications as well as the exact timestamps of API requests to SuiteProjects Pro servers. You should create a communication log that stores a minimum of the last seven days transactions. For information about contacting SuiteProjects Pro Support, see Creating a Support Case.

Upgrade With Caution

After you have tested your API integration and deployed it in production, you need to determine a process for upgrading or making changes to your SuiteProjects Pro account. Before you make any changes to your SuiteProjects Pro production account, you should always test these changes extensively against the API integration in your sandbox account. In particular, use care when you need to modify an object or application setting related to data or functionality that is tied to your API integration. Always test changes in your sandbox account prior to implementing them your production account.