...
The API gateway api calls and documentation can be accessed one of two ways; the API Gateway web page, or the preconfigured collection from the Postman collection below. The preconfigured collection contains configurations and examples for Authorization and common SharpenDB2 requests.
API Gateway documentation: Sharpen Public API
Postman download: Postman download
While there are many REST API tools available, we recommend Postman. The export below is in Postman json export v2.1
API Gateway Postman export:
...
Using Postman, import the API collection above
Once imported, navigate to the ‘Create New Authentication’ API call under the ‘Authorization setup' folder
Identify the ‘Authorization’ tab once selecting the api from the folder list
Choose ‘Basic Auth’ from the drop down
Enter the credentials of the Sharpen account corresponding with the account you’re interfacing with
Click ‘Send’
Response should look like
...
Identify the ‘Create Table’ request under the ‘SharpenDB2’ folder in the Postman collection
Under the ‘Authorization’ tab, set the ‘Type’ to “No Auth”
Under the ‘Headers’ tab add the following keys (
x-api-keyandx-api-secret)
Enter the values in correspondence with what was retrieved in the ‘Gathering apiKey and apiSecret’ section of this document
Under the ‘Body’ tab enter your query in JSON format
Click ‘Send’
The request and response should look something like this…
Query
Identify the ‘SharpenDB2 Select’ request under the ‘SharpenDB2’ folder in the Postman collection
Under the ‘Authorization’ tab, set the ‘Type’ to “No Auth”
Under the ‘Headers’ tab add the following keys (
x-api-keyandx-api-secret)Enter the values in correspondence with what was retrieved in the ‘Gathering apiKey and apiSecret’ section of this document
Under the ‘Body’ tab enter your query in JSON format
Click ‘Send’
The request and response should look something like this…
...