Cosmos DB SQL without postman

Question

Cosmos DB SQL without postman

Raja 86

Hi Team,
I'm using CosmosDB to store the JSON documents. The database gives inbuilt SQL REST API feature to query the database.

With this inbuilt feature I'm able to query data perfectly using GET and POST methods. This is working perfectly alright using "Postman". Now I want to try this for real consumer, which is not working.
I've imported the cosmosdb queries from git (https://github.com/MicrosoftCSA/documentdb-postman-collection) which is recommended by Microsoft in one of its tutorials .

Now when I looked this in detail, I see that Postman is using "Pre-request Script" where it is modifying

var mastKey = postman.getEnvironmentVariable("DocumentDBMasterKey");  
master key - var key = CryptoJS.enc.Base64.parse(mastKey);  
var signature = CryptoJS.HmacSHA256(text, key);  
var base64Bits = CryptoJS.enc.Base64.stringify(signature);  
var MasterToken = "master";  
var TokenVersion = "1.0";  
auth = encodeURIComponent("type=" + MasterToken + "&ver=" + TokenVersion + "&sig=" + base64Bits)

With this pre-script it works perfectly alright. But as a consumer how would I consume this?

Should consumer really bother about this script or he should just provide authentication token and required headers and the API should just work?
If consumer really need to write this pre-script, where would he write?

Any help would be highly appreciated.

Thanks

112617-cosmosdbsqlpostman-collection.txt

Saurabh Sharma 23,866 Reputation points Microsoft Employee Moderator

2021-07-07T23:21:41.767+00:00
Hi @Raja ,

Thanks for using Microsoft Q&A !!

With this pre-script it works perfectly alright. But as a consumer how would I consume this?

Should consumer really bother about this script or he should just provide authentication token and required headers and the API should just work?
Yes, you shouldn't be worry about this script as you could get the results by passing the authentication token and required headers normally your cosmos db endpoint using to Postman.

2) If consumer really need to write this pre-script, where would he write?
Could you please elaborate more on what is your customer want to achieve using this script as you could write your code/script using CosmosDB SDK or using Cosmos DB REST API calls from your script using languages like c#,Javascript, etc. SDK samples are available here for your reference as well. Also, here is a REST sample which you can refer to which uses REST calls for basic operations.
Please let me know if you have any other questions.

Thanks
Saurabh
Raja 86 Reputation points

2021-07-08T02:43:40.823+00:00
Hi @Saurabh Sharma Thanks for prompt response!

As soon as I remove the pre-script the rest calls stop working,

"code": "Forbidden", "message": "The authorization token is not valid at the current time. Please create another token and retry

So it's required. In fact I tried providing details using Insomnia tool providing details

Accept: application/json x-ms-version: 2018-12-31 Authorization: AUTH TOKEN STRING FROM COSMOSDB x-ms-date: Wed, 07 Jul 2021 10:24:54 GMT x-ms-documentdb-partitionkey: ["STR PART KEY"] RFC1123time: Wed, 07 Jul 2021 10:34:12 GMT

}IT gives me below error,

"code": "Unauthorized", "message": "Authorization header doesn't confirm to the required format. Please verify and try again.\r\nActivityId: 4d4f71ad-40bb-4b99-905e-75b27ba6c8e4, Microsoft.Azure.Documents.Common/2.14.0"

Question 1: So are you saying that cosmosdb SQL REST cannot directly be exposed but it needs some .NET/JS/Java code on top of it?

Question 2 : I have a simple question: I need to expose the Cosmosdb REST API to the consumer and I'll provide them only 2 things,
a. REST URL : https://{{DocumentDBHost}}/dbs/{{dbname}}/colls/{{containername}}/docs/{{id}}
b. basic header parameters : ( Accept, x-ms-version,Authorization,x-ms-date,x-ms-documentdb-partitionkey, RFC1123time).
Will they be able to access API using only these things ? or I need to do something additional?

1 answer

Your answer

Saurabh Sharma 23,866 Reputation points Microsoft Employee Moderator

2021-07-07T23:21:41.767+00:00

Hi @Raja ,

Thanks for using Microsoft Q&A !!

With this pre-script it works perfectly alright. But as a consumer how would I consume this?

Should consumer really bother about this script or he should just provide authentication token and required headers and the API should just work?
Yes, you shouldn't be worry about this script as you could get the results by passing the authentication token and required headers normally your cosmos db endpoint using to Postman.

2) If consumer really need to write this pre-script, where would he write?
Could you please elaborate more on what is your customer want to achieve using this script as you could write your code/script using CosmosDB SDK or using Cosmos DB REST API calls from your script using languages like c#,Javascript, etc. SDK samples are available here for your reference as well. Also, here is a REST sample which you can refer to which uses REST calls for basic operations.
Please let me know if you have any other questions.

Thanks
Saurabh
Raja 86 Reputation points

2021-07-08T02:43:40.823+00:00

Hi @Saurabh Sharma Thanks for prompt response!

As soon as I remove the pre-script the rest calls stop working,

"code": "Forbidden", "message": "The authorization token is not valid at the current time. Please create another token and retry

So it's required. In fact I tried providing details using Insomnia tool providing details

Accept: application/json x-ms-version: 2018-12-31 Authorization: AUTH TOKEN STRING FROM COSMOSDB x-ms-date: Wed, 07 Jul 2021 10:24:54 GMT x-ms-documentdb-partitionkey: ["STR PART KEY"] RFC1123time: Wed, 07 Jul 2021 10:34:12 GMT

}IT gives me below error,

"code": "Unauthorized", "message": "Authorization header doesn't confirm to the required format. Please verify and try again.\r\nActivityId: 4d4f71ad-40bb-4b99-905e-75b27ba6c8e4, Microsoft.Azure.Documents.Common/2.14.0"

Question 1: So are you saying that cosmosdb SQL REST cannot directly be exposed but it needs some .NET/JS/Java code on top of it?

Question 2 : I have a simple question: I need to expose the Cosmosdb REST API to the consumer and I'll provide them only 2 things,
a. REST URL : https://{{DocumentDBHost}}/dbs/{{dbname}}/colls/{{containername}}/docs/{{id}}
b. basic header parameters : ( Accept, x-ms-version,Authorization,x-ms-date,x-ms-documentdb-partitionkey, RFC1123time).
Will they be able to access API using only these things ? or I need to do something additional?

Answer 1

Deleted

This answer has been deleted due to a violation of our Code of Conduct. The answer was manually reported or identified through automated detection before action was taken. Please refer to our Code of Conduct for more information.

5 deleted comments

Comments have been turned off. Learn more