Services Administration
Overview
The Services Administration page enables users to create, view, edit, and delete external API APIs (application programming interfaces) are a set of protocols and definitions developers use to build and integrate application software. APIs act as the connective tissue between products and services. or authentication services. Examples of external services include Google Places API, Twilio API, OAuth2 Authentication Grants, and GPG Encryption/Decryption.
NOTE WSRBAC (workspace role-based access control) controls access to functions of Services Administration page. For more information on what roles can access and edit Services Administration data, view the Creator Role Administration article.
TIP To learn how to add a service to the environment, view our Administration Services - How to: Add a Service article.
Navigating to a Service
After creating a service. Creators Also known as Unqork Users, or Designer Users; is anyone who is inside the Unqork platform. can access the service's management page to edit service info, workspace access, service type, and more.
To access and edit a service from the Services Administration page:
| 1. | In the Services Administration list, navigate to the service you want to view or edit. |
| 2. | In the Actions column, click Manage. |
| 3. | Select Open. The service page displays. |
| 4. | At the top right of the page, click  Edit. |
Service Settings
Service Info
The Service Info section lets you name the service, and choose whether it's only available for server-side execution.
| Setting | Description |
|---|---|
|
Service Title* |
Enter the name of the service. A descriptive title helps other Creators understand the service. *This field is required. |
|
Service Name* |
The permanent system-name for the service. This value is for reference and cannot be changed. |
|
Allow Service Execution Server Side Only |
Set to (ON) to prevent the service from being used in modules with the Server-Side Execution Only setting set to (OFF). IMPORTANT When set to (ON), the service is configurable in non server-side modules, but it does not function in Express View. |
Manage Access
The Manage Access section controls if the environment or specific workspaces can use the service.
| Setting | Description |
|---|---|
|
Share to |
Grant service access to the environment, or select one or more workspaces where you want to share the service. WARNING Removing Environment or Workspaces access to a service breaks configurations using that service in the removed workspaces. |
Service Type
Use the Service Type section to set up the service connection.
| Setting | Description |
|---|---|
|
Service Type |
Specify the type of service you want to connect. The service type controls what settings are available for the authentication method. Service types include:
|
|
Service Protocol + Host |
Enter the service's endpoint to connect to Unqork. For example, https://places.googleapis.com/v1/places/ |
|
Authentication Method* |
The Authentication Method depends on the selected Service Type. |
Service Types
Unqork offers three service types: Authentication, Encryption, and FTP.
TIP To learn how to set up external APIs in detail, visit our How to: Setup External APIs article.
Authentication Service Type Settings
Creators can set up access to dozens of services using the Authentication Service Type. Refer to each service's API access documentation to see which authentication method they use, and what keys must be obtained to access.
NOTE Client Secrets, passwords, and other service information are encrypted and stored in the local database.
Using the menu below, select a service to discover its settings:
|
No AuthenticationNo Authentication provides support for SOAP Digital Signatures. TIP To learn how to set up SOAP Digital Signatures, view our Enabling Soap Digital Signatures article in the Doc Hub. OAuth2 Client Credentials GrantUse the OAuth2 Client Credentials grant when applications request an access token to access their own resources. TIP To learn more about the OAuth 2.0 Client Credentials Grant, view the following documentation: https://www.oauth.com/oauth2-servers/access-tokens/client-credentials/.
OAuth2 Password GrantThe OAuth 2.0 Password Grant exchange's the user's username and password for an access token. TIP To learn more about the OAuth 2.0 Password Grant, view the following documentation: https://www.oauth.com/oauth2-servers/access-tokens/password-grant/.
OAuth 2 JWT Bearer GrantThe OAuth 2.0 Bearer Grant grant uses a JSON Web Token to carry additional information in the payload. TIP To learn more about the OAuth 2 JWT Bearer Format, view the following documentation: https://datatracker.ietf.org/doc/html/rfc7523.
OAuth2 JWT Client Credential Grant ExtendedThe OAuth 2.0 Client Credential grant uses a JSON Web Token to carry additional information in the payload.
Bearer TokenBearer authentication uses security tokens called bearer tokens. Bearer tokens are cryptic strings generated by the server in response to a login request.
WSSE Username Token ProfileA Web Services Security Extension is an extension of SOAP to apply security to Web services. It is a member of the Web service specifications and published by OASIS. TIP To learn more about the WSSE Username Token Profile format, view the following documentation: https://docs.oasis-open.org/wss/v1.1/wss-v1.1-spec-pr-UsernameTokenProfile-01.htm.
TwilioThe Twilio REST API allows you to query metadata about your account, and send text messages. TIP To learn more about the Twilio API, view the following documentation: https://www.twilio.com/docs/iam/api-keys.
PlaidThe Plaid service enables access to Plaid's technology data transfer platform for financial products. TIP To learn more about the Plaid API, view the following the documentation: https://plaid.com/docs/api/.
Custom SOAP HeaderThe Custom SOAP header adds a header element to a SOAP request.
Basic AuthBasic Auth is the simplest method for creating authentication access in an HTTP Header. IMPORTANT Basic Authentication does not provide encryption or hashing for the transmitted credentials.
Canada PostThe Canada Post service enables access to the AddressComplete API. This API enables the Address Search component to search for addresses. TIP To learn more about the Canda Post API, view the following documentation: https://www.canadapost-postescanada.ca/ac/support/api/addresscomplete-interactive-find/. TIP To learn how to enable the Address Search component using Canada Post, view our Enabling Address Search Using Address Services article in the Doc Hub.
Google PlacesThe Google Places service enables access to requests for location data. This API enables the Address Search component to search for addresses. TIP To learn more about the Google Places API, view the following documentation: https://developers.google.com/maps/documentation/places/web-service/overview TIP To earn how enable the Address Search component using Google Places, view our Enabling Address Search Using Address Services article in the Doc Hub.
OpenID Connect (OIDC)OIDC is a secure exchange of information between an OpenID Provider (OP) and Unqork. The OP is any SSO Single Sign-On is an authentication scheme that enables users to use one set of login credentials across multiple services. provider, such as Okta, Microsoft Entra ID, or Amazon Cognito. Learn More To learn more about OpenID Connect, view the following documentation: https://openid.net/developers/how-connect-works/ TIP To learn more about OIDC in Unqork, visit our OpenID Connect (OIDC) article in the Doc Hub.
HyperscienceThe Hyperscience API provides access to the Hyperscience SaaS platform for automating document classification, identification, and extraction. Learn More To learn more about the Hyperscience API, view the following documentation: https://docs.hyperscience.com/#getting-started-guide.
HMACUse HMAC is a key-hashed message authentication code used to verify data integrity and authenticity of a data request. Learn More To learn more about HMAC, view the following documentation: https://datatracker.ietf.org/doc/html/rfc2104. TIP To learn how to set up an HMAC service in Unqork, view our How to: Set Up HMAC (Hashed Key) Authentication article in the Doc Hub.
|
(Encryption Service Type Settings
Unqork supports the GNU Privacy Guard (GPG) method for encrypting and decrypting payloads.
| Setting | Description |
|---|---|
|
Service Protocol + Host |
Enter the endpoint address for the service. |
|
Authentication Method* |
Set Encryption (GPG) or Decryption (GPG) as the service type's authentication method. |
|
Encryption (GPG) |
Insert the GPG Encryption value. Learn More To learn how to setup an encrypted SFTP SFTP (Secure File Transfer Protocol_ supports the transfer of files between an SFTP client and your server. Unlike FTP, it uses tunneling and performs transfers using a crytographic protocol to keep files secure. , view our How to: Set up GPG Encryption for Files article. |
|
GPG Public Key (Armored) |
Enter the public key provided by the service that's encrypting the files. |
|
Decryption (GPG) |
Insert the GPG Decryption value. Learn More To learn how to decrypt a file using GPG Encryption, view our How to: Set up GPG Encryption for Files article. |
|
GPG Private Key (Armored) |
Enter the private key provided by the service that's decrypting the files. |
FTP Service Type Settings
The File Transfer Protocol service type lets Creators connect their applications to a FTP FTP (File Transfer Protocol) supports the transfer of files between an FTP client and your server. or SFTP SFTP (Secure File Transfer Protocol_ supports the transfer of files between an SFTP client and your server. Unlike FTP, it uses tunneling and performs transfers using a crytographic protocol to keep files secure. server.
| Setting | Description |
|---|---|
|
Authentication Method* |
Set FTP FTP (File Transfer Protocol) supports the transfer of files between an FTP client and your server. or SFTP SFTP (Secure File Transfer Protocol_ supports the transfer of files between an SFTP client and your server. Unlike FTP, it uses tunneling and performs transfers using a crytographic protocol to keep files secure. as the service type's authentication method. IMPORTANT To improve security, use the SFTP method. Only use FTP if no other option is available. |
|
Host |
Enter the FTP/SFTP server or host address. |
|
Port (FTP Only) |
For FTP connections, enter the port value. Typical FTP ports values are 20 (data port) and 21 (controlled port). TIP SFTP uses port 22 by default. |
|
Username |
Enter the username or login value used to access the server. |
|
Password |
Enter the password value used to access the server. NOTE SFTP connections using SSH keys might not require a password, or they might require both. |
|
SSH Private Key (.pem) (SFTP Only) |
Insert the private key in .pem Privacy Enchanced Mail is a popular file format for storing and sending cryptographic keys. format. NOTE If the key uses the PuTTY (.ppk) file format, convert it to .pem using a conversion tool. |
|
Private Key Passphrase (SFTP Only) |
If your SSH key uses a passphrase, enter it in this field. |
FTP Service Type Resources
Request & Response
The Request and Response settings provide request headers, body, and response headers. Use these headers and body to provide required or additional information in the HTTP request made to the service. Values in these fields send with every request.
Request Headers
Request headers provide context about an HTTP request. They help define caching, authentication, and session state.
Request Body
Use the request body for create and update operations (POST, PUT, PATCH). The request body contains the resources to be created or updated.
NOTE Services might use the Request Body field in a GET request to define the data retrieved from a service.
Allowed Response Headers
Specify what header names will return in the HTTP response.
Logging
Logging service requests provides Creators with additional information on when and how a service is used.
Learn More To access and understand service logs, view our Understanding Service Logs article in the Doc Hub.
| Setting | Description |
|---|---|
|
Capture Request and Response Bodies |
Set to |
|
Retention Days (defaults to 30 days) |
Enter a value to retain services for longer or less than 30 days. |
|
PagerDuty Service Key (for optional alerting) |
Enter a service key to integrate service logs with PagerDuty. Learn More To learn more about PagerDuty API keys and service, view the following documentation: https://support.pagerduty.com/docs/pagerduty-agent-integration-guide#send-an-event-to-pagerduty. |
Logging Resources
Resources
