APIs require extensive documentation, right?
Not ours: the “API” tab of the add-in makes it easy to: create and upload calculator and document templates, test your templates, and view request and response JSON.
1. Create Templates
Create your Word and/or PowerPoint templates using the standard features of the AnalysisPlace add-in: link your workbook to your Word or PowerPoint documents. Test your templates using "Submit Content" in the Excel add-in and "Update Document" in the Word or PowerPoint add-in.
The result of the API Document Generation Service should be the same as the add-in “Update Document”.
The result of the API Calculation Service should be the same as performing calculations in your workbook (outputs are calculated based on inputs).
2. Upload Templates
Manage your Word, PowerPoint, or Excel templates. Uploaded documents will be available to your app via the API.
Each template is assigned a unique ID. Use this ID in your JSON to reference the template. You can update your templates at any time by uploading a new version.
3. Test Templates
Test your workbook and/or templates using data in the open workbook.
“Test API” submits JSON to the API (using your API key) based on content in the workbook the same way your app would submit data to the API. When your app submits data in the specified structure, the result should be the same.
The add-in shows the request and response JSON. For document updates, it allows you to download the generated document. For the Calculation API, it shows the resulting text, table data, and images (as a standard base64-encoded string) in the JSON.
4. Display Request JSON
Display the JSON data structure based on data in the open workbook. Your app should submit data in the general format displayed (but with your custom data).
The Request JSON is also updated when you test the API.
5. Develop Your App
Create/modify your app so it submits data in the JSON structure shown. Use the following endpoint: https://analysisplace.azurewebsites.net/apreportingservice.svc/documentAPI/v1.0. Submit a standard REST-based POST service request using any programming language.