Content Comparison

...

The API gateway api calls and documentation can be accessed one of two ways; the API Gateway web page, or the preconfigured collection within from the SharpenCare Postman workspace.collection below

API Gateway documentation: Sharpen Public API

Postman download: Postman download

API Gateway Postman export: Postman download

...

1. Using Postman, import the API collection above

2. Once imported, navigate to the “Create ‘Create New Authentication” Authentication’ API call under the ‘Authorization setup' folder

3. Identify the ‘Authorization’ tab once selecting the api from the folder list

4. Choose ‘Basic Auth’ from the drop down

5. Enter the credentials of the Sharpen account corresponding with the account you’re interfacing with

6. Click ‘Send’

7. Response should look like

   

...

Gathering apiKey and apiSecret

1. Navigate to the Create ‘Create API Key Key’ api call under the ‘Authorization Setup’ folder within the imported Postman collection.

2. Click the ‘Authorization’ tab and choose ‘Bearer Token’.

   

3. Insert the token gathered in step 7 of “Gathering your JWT” here

4. Navigate to the ‘Body’ tab

5. If you want an expiration on the token, update the date/time to the proper expiration time. If you do not want an expiration, modify the body to look like this.

   

6. Click ‘Send’

7. The return should look like this

   

...

1. Identify the ‘Create Table’ request under the ‘SharpenDB2’ folder in the Postman collection

2. Under the ‘Authorization’ tab, set the ‘Type’ to “No Auth”

3. Under the ‘Headers’ tab add the following keys (x-api-key and x-api-secret)

   

4. Enter the values in correspondence with what was retrieved in the ‘Gathering apiKey and apiSecret’ section of this document

5. Under the ‘Body’ tab enter your query in JSON format

6. Click ‘Send’

7. The request and response should look something like this…

   Image RemovedImage Added

Query

1. Identify the ‘SharpenDB2 Select’ request under the ‘SharpenDB2’ folder in the Postman collection

2. Under the ‘Authorization’ tab, set the ‘Type’ to “No Auth”

3. Under the ‘Headers’ tab add the following keys (x-api-key and x-api-secret)

   

4. Enter the values in correspondence with what was retrieved in the ‘Gathering apiKey and apiSecret’ section of this document

5. Under the ‘Body’ tab enter your query in JSON format

6. Click ‘Send’

7. The request and response should look something like this…

   

...