API Toolkit
The API Toolkit is ingeniously designed as a sandbox environment, ideal for developers seeking to experiment with and grasp their calculation requests without the hassle of navigating through dense technical documentation. It enables users to configure and execute sample requests intuitively, showcasing the impact of their settings on the API request body with just a few clicks.
The user interface of the API Toolkit is intelligently segmented into three principal areas:
1. Calculation Request Panel
2. Settings Panel
3. Calculation Response Panel
Calculation Request Panel
This segment of the interface features a JSON code editor where you can meticulously construct or amend the body of your API request. Essential elements that you must define include:
– workspaceId: Identifies your workspace.
– applicationId: Specifies the application you’re working with.
– transactionSequenceId: Can be set to null for current transactions or targeted directly for testing unpublished workbooks.
The editor facilitates the definition of your calculation inputs and outputs, ensuring a smooth setup for your application’s calculation needs.
Settings Panel
Transitioning to the Settings Panel, this area allows for the precise naming of your inputs and outputs. It provides options to decide whether to load or save records as part of the calculation and enables additional processes such as printing or emailing. Adding inputs and outputs is designed to be user-friendly, with the capability to specify values directly for specific cell ranges. It’s important to note that loading an existing record will cause any new inputs to override the existing data.
Calculation Response Panel
Upon initiating the ‘Calculate’ action, the response is showcased in this panel in a structured JSON format. Key elements to look for include:
– requestId: Useful for tracking your request.
– success flag: Quickly indicates the success status of your calculation.
– saveResult: If a record was saved, this will provide the new record ID and edit ID.