GraphQL is a query language for API’s. GLU supports integration into graphQL endpoints on outbound orchestrations. For more information on graphQL itself, you can find it here: https://graphql.org/
Connector Setup
GraphQL is available as an Outbound Connector within GLU. You can establish this Connector by following these steps:
- Creation: Begin by creating a new outbound connector dedicated to GraphQL. This connector serves as the bridge facilitating communication between GLU and GraphQL endpoints.
- Allocation: After creation, allocate the GraphQL connector to the pertinent GLU.Engines. This ensures its availability for use within the designated engines.
- Environment Configuration: Customize the connector settings in accordance with your environment’s specifications. This may entail defining endpoint URLs, authentication credentials, headers, or any other pertinent parameters essential for interacting with the GraphQL API.
By following these steps, you can seamlessly integrate GraphQL endpoints into your outbound orchestrations within GLU.
Integration Builder Usage
GraphQL requests can consist of 3 elements:
- Query: The written graphQL query
- Variables: A variable set that the graphQL query references
- Headers: Any HTTP headers required on the endpoint (Authorization etc).
GraphQL Query
To create an orchestration with the GraphQL Connector, follow these steps:
- Create Orchestration: Begin by creating a new orchestration within GLU.
- Select GraphQL Connector: When configuring the orchestration, choose the GraphQL Connector from the available options. This selection will trigger changes in the Request Manager panel.
- Add GraphQL Query: In the Request Manager panel, you’ll now see a Query field. Here, you can input your GraphQL query. Paste the query into this field as per your requirements.
- Syntax Validation: It’s important to note that the GLU.Console does not validate the GraphQL syntax. To ensure that your GraphQL query is correct and functional, it’s recommended to use external tools such as Postman or the GraphQL playground (https://www.graphqlbin.com/v2/new). These tools allow you to test and validate your GraphQL syntax before executing the orchestration in GLU.
This ensure that your GraphQL queries are properly formatted and functional before integrating them into your GLU orchestration.
GraphQL Headers
Headers can be added to the Outbound Request through the Request Parameter and marshalling the parameter to the Header.
GraphQL Variables
GraphQL variables are added into the Outbound Request through the use of the GLU parameters. Each variable required must be setup as a Request Parameter in the outbound orchestration.