Introduction:
TigerGraph supports users communicate with REST++ server, either by using one of the standard REST APIs included with the system, or by authoring and then employing a custom endpoint API. In this tutorial, we can learn how to set up the Postman environment and send query request to TigerGraph from Postman.
Prerequisite: Postman installed
Step 1: Initialize TigerGraph REST API ++ in postman
The TigerGraph REST API ++ website: https://documenter.getpostman.com/view/10822498/Szmh3wsw
Click Run in Postman and choose to open postman. You can see TigerGraph REST API ++ in Postman Collections.
Step 2: Set up a TigerGraph solution
Go to https://tgcloud.io. Click Create Solution and create a customized solution.
Follow the steps, name ‘Subdomain’, it’ll be used at the next step.
Start your solution, wait till it’s ready
Open in GraphStudio
Now you open your solution in GraphStudio:
Step 3: request query in postman
Click ‘Admin’ at the top-right hand corner and go to ‘user management’ page
Add a Secret Alias named ‘postman’ for your target schema and click ‘+’. You will have a secret for ‘postman’, copy that secret for future use.
Open your postman, click the ‘Manage Environment’ button at the top-right hand to add a new environment.
Adding new Environment, name your environment, set INITIAL VALUE and CURRENT VALUE of ‘url’ as your TigerGraph solution subdomain name, set INITIAL VALUE and CURRENT VALUE ‘token_secret’ as the secret you just copy, set INITIAL VALUE and CURRENT VALUE of graph_name as your target schema name.
After finishing adding, select the environment you just created.
Select ‘Get_requesttoken’ and send the request
You can get a token from this request, copy the token and paste it to your environment params ‘token’
Congratulations! You have finished the setup. Now you can send query requests to TigerGraph.
You can check all request urls by sending a request named ‘GET_endpoints’ in TigerGraph REST API ++ collection.
Here is ‘GET_GSQL_query’ use.
‘GET_GSQL_query’ is able to get a query result from your installed query.
Make sure variable ‘graph’ and ‘query_name’ is corresponding with your database. And don’t forget to input the query params.
