External Integration Documentation

When using Softools you may find yourself integrating other APIs into your App. Whilst doing so it is important to record information about it for other app builders and for your future self to return to should you want to make any modification to it. Rather then storing this information locally or any other methods of sharing it you can store it within App Studio called the ‘External Integrations’ area.

Configuration of an External Integration

To find the ‘External Integrations’ area select the App with the integration then click onto the 'Integrate' form. To add the documentation click onto the ‘Add External Integration’ button by clicking onto the blue ‘Add’ button or with the button in the ‘External Integrations’ template. This should direct you to a new page containing four templates called Process Map, Integration Service, Softools Api Endpoints and Implementation Method & Details.

Process Map

The first template you will find is the process map which is a visual representation of the activities and the actors responsible and the process of the Integration and its workflows.

To upload a diagram click onto the edit icon on the right of the template then click onto the Upload icon and select the file then click onto Ok.

Integration Service

Next is the ‘Integration Service’ which will be used to provide more clarification in what the integration is. This includes a brief outline of the integration, the type of Integration being captured such as a new Power BI integration, the status in the development, its purpose, and the link to access it. Only the Integration and Purpose are required fields so for a concept you will not have to fill out all the fields.

Softools API Endpoints

If you decide to use any of the Softools API endpoints it might be a good idea to track any endpoints used. Simply click on ‘Add Api Endpoint’ in which a pop up screen will open up where you can add the URL of the endpoint, authentication email, status of it publication and any additional comments.

Implementation Method & Details

Lastly comes the methods and details in where you can provide more information on how the workflow works between the services, any assumptions or limitations of the integration and future improvement ideas to consider for the future.

Once you have finished filling in all the information click onto the blue button ‘Save’. This will now save all the information written about the external integration onto this template for you or any other App Builders to refer to.