Admin Site
      Back to home
      1. OmniByte Self-Help
      2. FormsPro
      3. Admin Site

      Using the REST Connection Type

      How to use the REST connection type

      A REST connection type allows your form to securely connect to external web services or APIs (Application Programming Interfaces). This type of connection is commonly used to retrieve or send data between your form and another system—like a cloud service, application, or platform.

      REST is a standard way for different systems to communicate over the internet using familiar web methods like GET, POST, PUT, and DELETE. It allows your form to send and receive data using HTTP, the same protocol used by web browsers.

      1. From the Configuration menu on the left, select Data Connections.
      2. Click + Connection to open the Connection window. 
      3. Enter a connection name and description for the REST connection. This helps you identify the data connection if you connect to more than one database.
      4. Select REST as the connection type.
      5. Select Client Credentials as the grant type. The grant type defines how a form application obtains an access token from the authorization server. The client credential grant type indicates that the form application is acting on its own behalf to access resources.
      6. Enter the authentication server's endpoint in the Access Token URL field. This URL is used to exchange the authorization code for an access token.
      7. Enter the client identifier that was issued to the client during the application registration process in the Client ID field.
      8. Enter the client secret that was issued to the client during the application registration process in the Client Secret field. It displays encrypted. The client secret acts as a password to authenticate the form application to the authorization server.
      9. In the Scope field, specify the level of access the form application is requesting when it requests an access token from the authorization server.  It may have many space-delimited values.
      10. In the Resource field enter the specific endpoint that a form application intends to access.
      11. Click Test Connection to ensure your settings are correct. 
      12. Click Save when you've completed your changes.