Fetch API Specs
Introduction
Before executing the API to Push data to GO's platform, the structure of the request of the API is needed. The API request body is configured within the GO platform as per requirement. The JSON of the same journey can be fetched in 2 different ways:
- Download the API Specs from the Admin UI
- Push Merchant Specs API
There are two ways of getting API Specifications:
Method 1: We can get the JSON file for the push merchant specs from the Go-Admin portal.
Flows -> Select Flow-> Click on the settings βοΈ icon on the right corner of your flow-> Click on Download Push Merchant API specs-> The JSON file is downloaded successfully.
Method 2: API MethodΒ
The following API can be used to fetch the API specifications for pushing the data of the applications to the GO platform.
URL: https://go-preproduction.signzy.app/api/distributors/pushMerchantSpec/{{flowId}}?sampleData=trueο»Ώ
Sample Request
In the URL, we need to edit the flow-id and use the authentication token in the headers that we have created using the login API.
Then in response, weβll get the required API specification.
curl
--location
--request GET 'https://go-preproduction.signzy.app/api/distributors/pushMerchantSpec/{{flowId}}?sampleData=true' \
--header 'Authorization: <token>β
Sample Response
{
"flowId": "..flow_id..",
"realmId": "..realm_id..",
"merchantId": "..merchant_id..",
"data": [
{
"pageId": "..page_id..",
"widgetName": "..widget_name..",
"data": {
"parameter 1": "..data..",
"parameter 2": "..data..",
"parameter 3": "..data..",
.
.
.
"parameter n": "..data.."
}
},
{
"pageId": "..page_id..",
"widgetName": "..widget_name..",
"data": {
"parameter 1": "..data..",
"parameter 2": "..data..",
"parameter 3": "..data..",
.
.
.
"parameter n": "..data.."
}
}
]
}
Getting help
Please feel free to contact us if you have any questions, require clarification, or have ideas for how to make the documents or any of our services better.
You can reach out to us at [email protected].