Glyue User Docs
  • What is Glyue?
  • Tutorials
    • Start Here
    • Building a Single-Step Integration
      • 1. Creating the Integration
      • 2. Calling the External System
      • 3. Running the Integration
      • 4. Crafting the Output
    • Building a Multi-System Integration
      • 1. Connecting to the Core
      • 2. Field Mapping
      • 3. Running the Integration
    • Building an Event-Driven Integration
      • 1. Setting up the Mock CRM
      • 2. Receiving Inbound Requests
      • 3. Triggering the Integration from the CRM
    • Building an Email Integration
      • 1. Create and Configure the Integration
      • 2. Input Validation
      • 3. Get Story IDs from Hacker News
      • 4. Get Story Content
      • 5. Sending the Email
      • 6. Wrapping Up
      • 7. Extra credit
        • extra_credit.json
    • Building a RESTful CRUD Web Service
      • 1. Integration Setup
      • 2. Vault Setup
      • 3. Create Web Service Endpoints
      • 4. Execute Web Service Endpoints with Vault Methods
      • 5. Vault Code Examples and Explanation
    • Building a Retrieval API against FIS CodeConnect
      • 1. Integration Setup
      • 2. Service Request Setup
      • 3. Field Mapping Setup
      • 4. Integration and Service Request Hook Setup
      • 5. Testing the Integration
      • 6. Common Errors
    • What is Pre-Mapping?
      • Before you start
      • Bookmarks
      • Source and Targets
      • Field Mapping Status
      • Field Mapping Comments
      • Summary
  • How-To Guides
    • How to Run an Integration from Glyue
    • How to Invite New Users
    • How to Create a Value Mapping Set
    • How to Build and Deploy a Custom Frontend
    • How to Migrate an Integration
    • How to Set Up Single Sign On (SSO)
      • Glyue Setup
      • JumpCloud Setup
      • Azure Setup
      • Okta Setup
      • Glyue SAML Config Reference
    • How to Install the Glyue App for Zoom Contact Center
    • How to use the Vault
  • Reference
    • Integration Builder Page
    • Integration Anatomy
    • Integration Components
      • Integration
      • Service Request
      • Field Mapping
      • Value Mapping Set
      • Value Mapping
      • Validation Rule
      • Mask
      • Integration Config
      • Integration Engine Versions
    • Integration Lifecycle
    • Special Functions
      • add_run_label
      • callint
      • debug
      • end
      • get_namespace
      • humanize
      • import_helper
      • keep
      • list_files
      • map_value
      • open_glyuefile
      • open_vault
      • Data Manipulation Utilities
      • calladapter
    • Special Variables
      • __adapter_config__
      • input
      • parentint
      • retvalue
      • run_history_id
      • Iterables
        • fitem/fidx
        • sritem/sridx
        • vritem/vridx/vrmsg
    • Adapters
      • Generic HTTP Adapter
      • Email SMTP Adapter
    • Web Service Endpoints
    • Vault Reference
  • Glyue Platform Reference
    • Banking Core Connectivity Guide
    • Authentication
    • Permissions
      • Service Accounts
      • Organizations
    • Frontends
    • Idempotency Layer
    • Integration Scheduler
    • Governance Reports
    • Arbitrary Integration Request Content Support
    • Admin Components
    • Logging
  • ETL
    • Glyue ETL Overview
    • Data Connectors
    • Workflows
    • Run History
    • Scheduler
Powered by GitBook
On this page
  • Create a Web Service Endpoint
  • Using a Webservice Endpoint
  • Fields

Was this helpful?

  1. Reference

Web Service Endpoints

Configuration reference for non-default HTTP(S) integration API paths and verbs

PreviousEmail SMTP AdapterNextVault Reference

Last updated 6 months ago

Was this helpful?

Glyue supports building web services that execute integrations via user-defined URL paths and methods. These enables the construction of traditional RESTful web services as explained in the Building a RESTful CRUD Web Service guide.

Only URL paths starting with /api/ or /rest/ are currently supported.

Create a Web Service Endpoint

To create a web service endpoint for an integration:

  1. Navigate to the Build page using the navigation sidebar.

  2. Right-click on the integration you want to create a webservice endpoint for. Click Configure.

  3. Exapnd the Webservice Endpoints section, then click + Add Webservice Endpoint

  4. Fill the fields, then click Save.

Using a Webservice Endpoint

The full URL for a webservice endpoint is your.environment.name.sandboxbanking.com/prefix/path_name where

  • prefix is either api or rest

  • path_name is the path name configured in the webservice endpoint, not the pathname of the integration

Fields

Name
Example Value (s)
Description

Path

Example: q2/apps

Specifies the endpoint's URL path following the initial /api/ or /rest/ root fragment. Do not include a leading / .

Method

GET, POST, PUT, PATCH, DELETE

Specifies the HTTP method used for calling the API.

Prefix

/api, /rest

Specifies the endpoint URL's root path fragment. All web service endpoints must start with either /api/ or /rest/.

Description

Example: Retrieves applications from Q2 Gro online deposit opening system

Description of the web service endpoint.

Response content type

application/json, application/html, text/xml, text/html, application/soap+xml

Specifies the integration response type.