Connectivity: REST
Overview
REST connectivity can be used with web services that use REST APIs, such as SAP Business One, Zoho CRM, iugu and Google Fit.
If the system already has an API, on the platform can use it directly, adding rate limit and security controls, which makes it easier to integrate with other platforms.
The platform works with the JSON format, allowing the following HTTP request methods:
POST
GET
UPDATE
DELETE
PATCH
Authentication types
If you choose the REST connectivity type, you will have the following Authentication Type options:
No Auth: open connection, without any type of authentication;
Basic: simple connection, with user and password;
Bearer Token: connection that requires a token in JSON Web Token (JWT) format or other desired format;
OAuth 1: connection with authentication in the OAuth 1.0 standard;
OAuth 2: connection with authentication to the OAuth 2.0 standard;
Cookie: connection that uses cookies to authenticate client requests and store user session information;
AWS: connection with HMAC authentication, which allows access to AWS services;
OAuth2 JWT: connection with authentication to the OAuth 2.0 standard and using a JWT token;
Header Authentication: use of header information in a request.
How to connect an account
After defining the type of connectivity, the next step is to choose the type of authentication. Only after these settings have been made will you be able to add a new account, as well as select, edit or remove one of the previously registered accounts.
To add a connected account, click on "Connected account" and then "Add connected account".
To continue with the configuration, click on the tab of the chosen authentication type:
Important: pay attention to the “Host” field in the Connected Account configuration, as the data will be concatenated with the operations configuration.
No Auth
When you choose the "Add connected account" option, the following modal will be displayed:
Fill in the details:
Terminal (optional): if you have a terminal set up, select it so that the connection is made through the corresponding "Agent";
Account name: name of the registered account;
Host: IP address of the API;
Port: API port number.
After filling in the details, click on "Create account".
That's it! Your connected account has been created and can be used by other modules and flows, appearing among the options of accounts configured in both cases.
Basic
When you choose the "Add connected account" option, the following modal will be displayed:
Fill in the details:
Terminal (optional): if you have a terminal set up, select it so that the connection is made through the corresponding "Agent";
Account name: name of the registered account;
Host: IP address of the API;
Port: API port number;
User;
Password.
After filling in the details, click on "Create account".
That's it! Your connected account has been created and can be used by other modules and flows, appearing among the options of accounts configured in both cases.
Bearer Token
When you choose the "Add connected account" option, the following modal will be displayed:
Fill in the details:
Terminal (optional): if you have a terminal set up, select it so that the connection is made through the corresponding "Agent";
Account name: name of the registered account;
Host: IP address of the API;
Port: API port number;
Token: token created.
After filling in the details, click on "Create account".
That's it! Your connected account has been created and can be used by other modules and flows, appearing among the options of accounts configured in both cases.
OAuth 1
When you choose the "Add connected account" option, the following modal will be displayed:
Fill in the details:
Terminal (optional): if you have a terminal set up, select it so that the connection is made through the corresponding "Agent";
Account name: name of the registered account
Host: IP address of the API
Port: API port number
Client Key: user required for authentication
Client Secret: password required for authentication
Access token: token used to access an API
Token secret: token obtained to grant a new access token without the user having to log in again
Signature method: security technique that uses HMAC-SHA1 to ensure authenticity.
After filling in the details, click on "Create account".
That's it! Your connected account has been created and can be used by other modules and flows, appearing among the options of accounts configured in both cases.
OAuth 2
When you choose the "Add connected account" option, the following modal will be displayed:
Fill in the details:
Account name: name of the registered account
Host: IP address of the API
Port: API port number
Client ID: user required for authentication
Client Secret: password required for authentication
Access token: token used to access an API
Refresh token: token obtained to grant a new access token without the user having to log in again
Token exchange endpoint: URL used to obtain tokens to authorize users
Content type: data format that will be transmitted in the request. By default, it is in JSON format, but can be changed to URL Encoded.
Parameters of the token payload:
Key: identifier or name associated with a particular piece of information in the token payload.
Value: data associated with the key, contextualizing the authentication information previously entered.
Key of the response with the token: JSON key that will return the token information in the body. By default, it's the Access Token (in this case, you don't need to enter it in the field), but in cases where it's another token (Zoho Token, for example) you need to specify it.
Response key with refresh token: JSON key that will return the Refresh Token information in the body.
Send token exchange parameters as query string: if selected, causes the Refresh Token parameters to be sent as a query string.
Parameters in the request header after authentication:
Key: Name of the parameter that will be sent in the GET call Clients on a Resource Server. For example: Authorization.
Value: Associated data that will be needed to transmit or authenticate access. For example: Bearer <>token</>
After filling in the details, click on "Create account".
That's it! Your connected account has been created and can be used by other modules and flows, appearing among the options of accounts configured in both cases.
Cookie
When you choose the "Add connected account" option, the following modal will be displayed:
Fill in the details:
Terminal (optional): if you have a terminal set up, select it so that the connection is made through the corresponding "Agent";
Account name: name of the registered account;
Host: IP address of the API;
Port: API port number;
Authentication endpoint: URL used to authenticate the user;
Cookie (optional): content of the cookie
Body (optional): content of the request body needed to generate the cookie.
After filling in the details, click on "Create account".
That's it! Your connected account has been created and can be used by other modules and flows, appearing among the options of accounts configured in both cases.
AWS
When you choose the "Add connected account" option, the following modal will be displayed:
Fill in the details:
Account name: name of the registered account;
Host: IP address of the API;
Port: API port number;
AWS Access Key ID: AWS account user;
AWS Secret Access Key: AWS account password;
AWS Service: AWS service you wish to use. Examples: s3, ses, ecs2;
AWS region: region within the AWS nomenclature. Examples: us-east-1, ap-southeast-1.
After filling in the details, click on "Create account".
That's it! Your connected account has been created and can be used by other modules and flows, appearing among the options of accounts configured in both cases.
OAuth2 JWT
When you choose the "Add connected account" option, the following modal will be displayed:
Fill in the details:
Account name: name of the registered account;
Host: IP address of the API;
Port (optional): API port number;
Private Key: click to upload a private key file (.pem);
Authentication URL: URL for requesting the authentication token;
.JWT expiration time (s): time before the JWT token expires (in seconds)
Content type: data format that will be transmitted in the request. By default, it is in JSON format, but can be changed to URL Encoded.
Parameters in the JWT payload - parameters that can be entered (KEY and VALUE fields):
iss (issuer): issuer of the token
aud (audience): recipient of the token, represents the application that will use it
scope: scope of data requested
Parameters in the body of the token request - parameters that can be entered (KEY and VALUE fields):
authorization: enter the value of the authorization token here
Response key: token
Parameters in the request header after authentication - parameters that can be entered (KEY and VALUE fields):
authorization: enter the value of the authorization token here
After filling in the details, click on "Create account".
That's it! Your connected account has been created and can be used by other modules and flows, appearing among the options of accounts configured in both cases.
Header Authentication
When you choose the "Add connected account" option, the following modal will be displayed:
Fill in the details:
Account name: name of the registered account;
Host: IP address of the API;
Port (optional): port number of the API;
Header options:
Key: Name of the parameter that will be sent
Value: Associated data that will be needed to transmit or authenticate access.
After filling in the details, click on "Create account".
That's it! Your connected account has been created and can be used by other modules and flows, appearing among the options of accounts configured in both cases.
Finally, click on "Save changes" to configure your module settings.
Important: after saving the changes, it will no longer be possible to change the Connectivity type and/or Authentication type.
Next step: Create operations for the module
Read also:
Last updated