Getting Started¶
The Getting Started Guide introduces key tools and concepts to be understood before using the REST: Toolkit. Below, you will find the links and references needed to introduce and begin usage of the REST: Toolkit.
Prerequisites¶
Before using the REST: Toolkit for development, you should know what the Snippet Framework is by reviewing the Getting Started guide of the Snippet Framework (aka silo_low_code). That section walks you through what you need to know to begin developing with this and other toolkits.
Overview¶
The REST: Toolkit PowerPack is an extension of the Snippet Framework for building REST based Dynamic Applications in a low-code manner.
The REST: Toolkit PowerPack includes:
An execution environment with REST and other standard steps necessary for REST Dynamic Application development.
A template Dynamic Application that demonstrates the REST steps.
Support for basic authentication APIs.
This toolkit PowerPack is also the end-product of what one would build when following the Snippet Framework Development tutorial.
Authentication Capabilities¶
The REST: Toolkit following authentication schemas are supported out-of-the-box:
Basic
Token Bearer
API Key
Oauth2
Client credentials grant type
Resource owner password credentials grant type
Refer to Authentication for an in-depth overview on how to use the different authenticators.
Converting from REST PowerPack¶
While the REST PowerPack and REST: Toolkit share the concept of low-code for development, the results of execution are not 1:1. The REST: Toolkit uses different indices than the REST PowerPack. This will cause the existing Dynamic Application to have new indices and the historical data will be lost. If you wish to maintain the same indices of the REST PowerPack, you must create a step that stores the data as a dictionary where the dictionary keys align with the indices from the REST PowerPack.
Troubleshooting¶
If you encounter issues while using the REST: Toolkit or Snippet Framework, you can find additional information at Logging/Debugging.
Known Issues¶
Some fields may display incorrectly when a user changes a previously selected
Authentication Type
to a new type in the REST Snippet Framework credential.
To correct these fields, you must close out the in-progress configuration of
the credential without saving. Then, re-open and select the desired
Authentication Type
.