The APP LIBRARY lists all applications that are available through Cloudsnap. Each is a third-party application that Cloudsnap can access through connectors with authentication, endpoints, and triggers.
Application in MYAPPS
When you add an application from the library, you can use data from the APP Template that Cloudsnap has created.
- Authentication fields, base URL (if one is needed), to set up a connection between the application and Cloudsnap. Click the application’s Connect button to view its required authentication fields.
Connecting window with fields for authentication credentials
- Endpoints from the application’s API documentation, webhooks, and triggers when you build workflows. These can be found on the APP template. Click the application’s row in MYAPPS to view the page.
Application Template with endpoints, webhooks, and triggers
Template Data
Just as with any template, an APP sets up the applications' standard fields.
The basic data for any application includes the following
-
Authentication type
-
Base URL
-
Endpoints
-
Test Endpoints
-
Triggers and Webhooks
Authentication Types
The authentication types determine sets the values and the method that a customer needs to authenticate an application. Authentication validates that users are who they claim to be so they can access an application’s connectors, endpoints, and standard triggers. Cloudsnap sets the type for each template.
Cloudsnap supports the following authentication types:
-
Basic
-
Cookies
-
OAuth
-
Token
-
Hybrid OAuth
-
Custom
After the type is established, Cloudsnap adds the Authentication values on the Edit App Template page. The values are the credentials used to access an application’s endpoint. All value fields are optional. The values contain the following data:
-
Location indicates where the value is to appear in the API request: header, params (body), or URL.
-
Label is the displayed text.
-
Key is either the header name or the JSON body key.
-
Value is the actual value sent to the application for authentication.
-
Default Value is the value use if there is none in the Value field.
-
Checkboxes turn the options on and off.
-
Field Type is text or password.
-
Filter
Base URL
A Base URL is the consistent part of an endpoint’s web address. When you develop workflows for an application, the path for the endpoint you chose from the APP template is appended to the Base URL. This directs the API call to a specific location where resources are found or posted.
Obtain the base URL from the application vendor’s API documentation. Below is an example of a Base URL with an appended endpoint path.
Endpoints
An endpoint is a component of an API. While the API is the set of rules that define how two applications share data resources, an endpoint is the location of those resources.
Cloudsnap APP pages list the endpoints from source applications' API documentation. either Cloudsnap or another vendor.
See About Endpoints.
Test Endpoints
Whenever you click Submit to connect to an application, Cloudsnap automatically tests the connection. If you do not set up a test URL in your account, Cloudsnap uses the test endpoint in the APP template. However, the test endpoint in your instance of the application overrides the template’s test data.
You can also add parameters (params) in the template, so a connection test does not return a large payload.
Triggers and Webhooks
The trigger defines the conditions that initiate the workflow instance and how data is collected from a source application. The webhook, a URL, is a direct connection to a website, which is itself an endpoint.
See About Triggers.
Comments
0 comments
Please sign in to leave a comment.