Creating a Graph QL Connection

Owned by Rojer Benny CTOO
Nov 26, 2024
3 min read

Sigma enables you to create a Graph QL connection, you can make request to fetch data form multiple data sources with a single API call using data query. Graph QL enables clients to request exactly the data they need, avoiding over-fetching. These results in optimized data calls which reduces the network latency.

To create a Graph QL connection, perform the following steps:

  1. Click Manage>Connection in Sigma Studio.

The Create New Connection page appears

  1. Click Web Service and select GraphQL logo to create a GraphQL connection.

  1. Enter a unique name in the Connection Name field.

  1. If you are connecting to POST API, provide the entire URL in the Domain Name field.


(or)
If you are connecting to GET API provide only the domain name/base URL in the Domain Name field.

Note: You can also connect to the REST endpoint by just providing the domain name/ base URL of the REST API in the Domain Name field.

  1. Select the GRAPHQL Data Fetching Activity chain from the list of available activity chains in the Activity Chain field.
    Note: This activity internally connects GraphQL endpoint to fetch the data based on the connection details.

  1. If required, you can pass any header parameters for the API in the Headers section.

Note:
Click the + icon to add any additional header parameters.

Click the Delete icon to delete the added header parameter.

  1. Select the authentication type required for your GraphQL endpoint from the Authentication Type field.

    1. No Authentication. If No Authentication is the authentication type proceed to step 9.

    2. OAuth 2. If Oauth 2 is the authentication type proceed to step 8.

  1. If OAuth 2 is the authentication type for your GraphQL endpoint, proceed with the following steps:

    1. Enter the OAuth2 API URL in the Token URL field, to get the access token from the API.

b. In the Auth Headers section, add the required the header parameter to generate the access token for the GraphQL endpoint.

  1. Click Submit button to create a connection with configured GraphQL endpoint.

  1. Click OK to the Success Message.

Refer the following page:

Creating a Graph QL Data Source