NoSQL Cloud Service REST APIs Programmatically using Shell (curl)

[dario-vega]

There are multiple possibilities for testing the NoSQL Cloud service.

• You can use the oci cli command, a Linux tool that allows you to interact with the service without generating all the signatures. The tool is doing it for you. Behind the scenes, it will execute the REST calls for you. More here in the OCI documentation. It simplifies a lot.
• You can also test using Postman. You can find here a complete end-to-end example - https://www.postman.com/oracledevs/oci-nosql-playground/collection/b6675ki/end-to-end-example
• etc

Let me provide examples using GET, DELETE, POST, and PUT. All are using the following env variables with the information for the
authentication. There are additional headers you need to add when using curl with the POST and PUT methods. The best is to use a file and use the curl option --data-binary "@filename"

OCI_PRIVATE_KEY="/home/opc/.oci/h.pem"
TENANCY_OCID="ocid1.tenancy.oc1..xxxxxxxxxx"
USER_OCID="ocid1.user.oc1..xxxxxxxxxxxxx"
API_KEY_FINGERPRINT="49:42:42:11:2e:xxxxxxxxxxxxxxxxxxxx:9b:33:d0"
COMPARTMENT_OCID="ocid1.compartment.oc1..xxxxxx"

Using GET commands

COMPARTMENT_OCID="ocid1.compartment.oc1..xxxxxx"
HOST="nosql.us-ashburn-1.oci.oraclecloud.com"

REST_API="/20190828/tables?compartmentId=$COMPARTMENT_OCID"
METHOD=GET

date=`date -u "+%a, %d %h %Y %H:%M:%S GMT"`
date_header="date: $date"
host_header="host: $HOST"
request_target="(request-target): ${METHOD,,} $REST_API"
# note the order of items. The order in the signing_string matches the order in the headers
signing_string="$request_target\n$date_header\n$host_header"
headers="(request-target) date host"


printf '%b' "signing string is $signing_string \n"
signature=`printf '%b' "$signing_string" | openssl dgst -sha256 -sign $OCI_PRIVATE_KEY | openssl enc -e -base64 | tr -d '\n'`
printf '%b' "Signed Request is  \n$signature\n"

curl -X $METHOD -sS https://$host$rest_api/ -H "date: $date" -H "Authorization: Signature version=\"1\",keyId=\"$TENANCY_OCID/$USER_OCID/$API_KEY_FINGERPRINT\",algorithm=\"rsa-sha256\",headers=\"$headers\",signature=\"$signature\"" | jq

Using DELETE, it is the same script as above for GET. Here is an example of deleting a table called the blog table. You can also use the table's ocid.

COMPARTMENT_OCID="ocid1.compartment.oc1..xxxxxx"
HOST="nosql.us-ashburn-1.oci.oraclecloud.com"

REST_API="/20190828/tables/blogtable?compartmentId=$COMPARTMENT_OCID"
METHOD=DELETE

date=`date -u "+%a, %d %h %Y %H:%M:%S GMT"`
date_header="date: $date"
host_header="host: $HOST"
request_target="(request-target): ${METHOD,,} $REST_API"
# note the order of items. The order in the signing_string matches the order in the headers
signing_string="$request_target\n$date_header\n$host_header"
headers="(request-target) date host"


printf '%b' "signing string is $signing_string \n"
signature=`printf '%b' "$signing_string" | openssl dgst -sha256 -sign $OCI_PRIVATE_KEY | openssl enc -e -base64 | tr -d '\n'`
printf '%b' "Signed Request is  \n$signature\n"

curl -X $METHOD -sS https://$host$rest_api/ -H "date: $date" -H "Authorization: Signature version=\"1\",keyId=\"$TENANCY_OCID/$USER_OCID/$API_KEY_FINGERPRINT\",algorithm=\"rsa-sha256\",headers=\"$headers\",signature=\"$signature\"" | jq

Using POST, I created a JSON file with the query to execute. And I add the additional headers

cat ./restbody.json
{
  "compartmentId": "ocid1.compartment.oc1..xxxxxx",
  "statement": "select * from AgentInventoryEntity",
  "consistency": "EVENTUAL",
  "isPrepared": false,
  "maxReadInKBs": 0,
  "timeoutInMs": 5000
}

HOST="nosql.us-ashburn-1.oci.oraclecloud.com"

REST_API="/20190828/query"
METHOD=POST
# JSON file used for POST/PUT methods
BODY="./restbody.json"

date=`date -u "+%a, %d %h %Y %H:%M:%S GMT"`
date_header="date: $date"
host_header="host: $HOST"

# headers required for a POST/PUT request
body_arg=(--data-binary @${BODY})
content_sha256="$(openssl dgst -binary -sha256 < $BODY | openssl enc -e -base64)";
content_sha256_header="x-content-sha256: $content_sha256"
content_length="$(wc -c < $BODY | xargs)";
content_length_header="content-length: $content_length"
headers="(request-target) date host"
# add on the extra fields required for a POST/PUT
headers=$headers" x-content-sha256 content-type content-length"
content_type_header="content-type: application/json";

request_target="(request-target): ${METHOD,,} $REST_API"
signing_string="$request_target\n$date_header\n$host_header"
signing_string="$signing_string\n$content_sha256_header\n$content_type_header\n$content_length_header"
printf '%b' "signing string is $signing_string \n"
signature=`printf '%b' "$signing_string" | openssl dgst -sha256 -sign $OCI_PRIVATE_KEY | openssl enc -e -base64 | tr -d '\n'`
printf '%b' "Signed Request is  \n$signature\n"

curl -v -X $METHOD --data-binary "@$BODY" -sS https://$host$rest_api/ -H "date: $date" -H "x-content-sha256: $content_sha256" -H "content-type: application/json" -H "content-length: $content_length" -H "Authorization: Signature version=\"1\",keyId=\"$TENANCY_OCID/$USER_OCID/$API_KEY_FINGERPRINT\",algorithm=\"rsa-sha256\",headers=\"$headers\",signature=\"$signature\"" | jq

Using PUT, I created a JSON file with the row to UPSERT a value in a table called users. It uses the same script above for POST. You can also use the ocid of the table (in this case, you don’t need the compid in the file).

cat ./mydata.json

{
   "value": {
    "id": 1,
    "name": "John Doe"
   },
   "compartmentId": "ocid1.compartment.oc1..aaaaaaaa4mlehopmvdluv2wjcdp4tnh2ypjz3nhhpahb4ss7yvxaa3be3diq",
   "isExactMatch": false,
   "isGetReturnRow": true,
   "isTtlUseTableDefault": true,
   "timeoutInMs": 5000
}


COMPARTMENT_OCID="ocid1.compartment.oc1..xxxxxx"
HOST="nosql.us-ashburn-1.oci.oraclecloud.com"

REST_API="/20190828/tables/users/rows"
METHOD=PUT

# JSON file used for POST/PUT methods
BODY="./mydata.json"

date=`date -u "+%a, %d %h %Y %H:%M:%S GMT"`
date_header="date: $date"
host_header="host: $HOST"

# headers required for a POST/PUT request
body_arg=(--data-binary @${BODY})
content_sha256="$(openssl dgst -binary -sha256 < $BODY | openssl enc -e -base64)";
content_sha256_header="x-content-sha256: $content_sha256"
content_length="$(wc -c < $BODY | xargs)";
content_length_header="content-length: $content_length"
headers="(request-target) date host"
# add on the extra fields required for a POST/PUT
headers=$headers" x-content-sha256 content-type content-length"
content_type_header="content-type: application/json";

request_target="(request-target): ${METHOD,,} $REST_API"
signing_string="$request_target\n$date_header\n$host_header"
signing_string="$signing_string\n$content_sha256_header\n$content_type_header\n$content_length_header"
printf '%b' "signing string is $signing_string \n"
signature=`printf '%b' "$signing_string" | openssl dgst -sha256 -sign $OCI_PRIVATE_KEY | openssl enc -e -base64 | tr -d '\n'`
printf '%b' "Signed Request is  \n$signature\n"

curl -X $METHOD --data-binary "@$BODY"-sS https://$host$rest_api/ -H "date: $date" -H "x-content-sha256: $content_sha256" -H "content-type: application/json" -H "content-length: $content_length" -H "Authorization: Signature version=\"1\",keyId=\"$TENANCY_OCID/$USER_OCID/$API_KEY_FINGERPRINT\",algorithm=\"rsa-sha256\",headers=\"$headers\",signature=\"$signature\"" 

I hope it helps. Let me know