Rest API connection method
Before setting up a connection to the Rest API feed, you should test out with any of the software to check whether the API can retrieve the product or not.
Example of software: Postman
If you do not know how to test out the API request using other software, please do contact support via support@stock-sync.com and provide the API doc and API key.
Fill in the endpoint URL based on your API request.
Select the Authorization Type needed for that API request. There are a few types of authorization which are Basic Auth, Bearer Token, Oauth2, and No Auth.
a) Basic Auth
This authorization method involves username and password only. When your API request with username and password you can select Basic Auth.
b) Bearer Token
A bearer token is another method of authorization that uses tokens from your API. So that, you can fill up the token in the required field.
c) Oauth2
Oauth2 is to provide consented access and restrict actions of what the client app can perform on resources on behalf of the user, without sharing the user's credentials. So certain APIs use this method to secure their authorization. If your API URL, using this method please select this and insert all the respective details.
d) Oauth2 with password
Oauth2 is to provide consented access and restrict actions of what the client app can perform on resources on behalf of the user, without sharing the user's credentials. So certain APIs use this method to secure their authorization with password. If your API URL, using this method please select this and insert all the respective details.
If there are any header params or query params that need to be keyed in for that API request and fill in the given field. To know more about the query param and header param, refer here.
For the Body Raw is defined as the filter part. If you wanted to filter any collection or Category from the Rest API. You may use Body Raw to enter the filter category or collections as well in the provided field.
Choose the HTTP method:
GET: retrieves information from the server
PUT: used to create
POST: accept the data enclosed in the body of the request message, most likely for storing it
Ensure the correct File Format.
Example of software: Postman
If you do not know how to test out the API request using other software, please do contact support via support@stock-sync.com and provide the API doc and API key.
Fill in the endpoint URL based on your API request.
Select the Authorization Type needed for that API request. There are a few types of authorization which are Basic Auth, Bearer Token, Oauth2, and No Auth.
a) Basic Auth
This authorization method involves username and password only. When your API request with username and password you can select Basic Auth.
b) Bearer Token
A bearer token is another method of authorization that uses tokens from your API. So that, you can fill up the token in the required field.
c) Oauth2
Oauth2 is to provide consented access and restrict actions of what the client app can perform on resources on behalf of the user, without sharing the user's credentials. So certain APIs use this method to secure their authorization. If your API URL, using this method please select this and insert all the respective details.
d) Oauth2 with password
Oauth2 is to provide consented access and restrict actions of what the client app can perform on resources on behalf of the user, without sharing the user's credentials. So certain APIs use this method to secure their authorization with password. If your API URL, using this method please select this and insert all the respective details.
If there are any header params or query params that need to be keyed in for that API request and fill in the given field. To know more about the query param and header param, refer here.
For the Body Raw is defined as the filter part. If you wanted to filter any collection or Category from the Rest API. You may use Body Raw to enter the filter category or collections as well in the provided field.
Choose the HTTP method:
GET: retrieves information from the server
PUT: used to create
POST: accept the data enclosed in the body of the request message, most likely for storing it
Ensure the correct File Format.
Updated on: 30/07/2024
Thank you!