How to turn Postman API's request into Apps Script code? - google-apps-script

I'm currently using Postman to do an API post request from a CRM software called Intercom.
I followed the below documentation to do this:
https://developers.intercom.com/intercom-api-reference/v0/reference/creating-an-export-job
My purpose is to create a script via Google Apps Script to automate the API request.
I need to give the following elements:
Method: Post
URL: https://api.intercom.io/export/content/data
Headers: Authorization : Bearer 123456789, Accept : application/json, Content-Type: application/json
Body: "created_at_after": 1654041600, "created_at_before": 1656547200 (this is the date in Unix Timestamp)
The only parameter that will change is the body ("created_at_after" and "created_at_before"). Everything else will remain the same.
Below is the script I've created, that currently does not work.
Any help on how to fix this would be appreciated. I'm quite a beginner programmer so apologies in advance if the problem is quite obvious.
function exportjob() {
var url = 'https://api.intercom.io/export/content/data';
var options = {
"Method": "post",
"Headers": {
"Authorization": "Bearer 123456789",
"Accept": "application/json",
"Content-Type": "application/json"
},
"Body": {
"created_at_after": 1654041600,
"created_at_before": 1656547200}
}
var response = UrlFetchApp.fetch(url, options);
}

From your showing document, I believe your goal is as follows.
You want to convert the following curl command to Google Apps Script.
curl https://api.intercom.io/export/content/data \
-X POST \
-H 'Authorization:Bearer <Your access token>' \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' -d '
{
"created_at_after": 1527811200,
"created_at_before": 1530316800
}'
Modification points:
At params of fetch(url, params) of Class UrlFetchApp, there are no properties of Method, Headers, Body.
In your situation, it seems that it is required to be sent the data as the string. And, by the content type of application/json, the data is parsed at the server side.
When these points are reflected in your script, how about the following modification?
Modified script:
function exportjob() {
var url = 'https://api.intercom.io/export/content/data';
var options = {
"method": "post",
"headers": {
"Authorization": "Bearer 123456789",
"Accept": "application/json",
},
"contentType": "application/json",
"payload": JSON.stringify({
"created_at_after": 1654041600,
"created_at_before": 1656547200
})
}
var response = UrlFetchApp.fetch(url, options);
console.log(response.getContentText())
}
Note:
If an error occurs for the request, please confirm your access token and the data again. And, please provide the error message.
Reference:
fetch(url, params)

Related

API access works in curl but UrlFetchApp returns 400 Bad Request

I'm trying to access my Home Assistant API and it works fine using curl, but not in Google Apps Script using UrlFetchApp. Using curl works fine:
curl -X GET -H "Authorization: Bearer longFunkyCodeLikeThisiJ9.eyJpc3Mijk5fQ.0Fpw8I" -H "Content-Type: application/json" https://mydevice.duckdns.org:8123/api/states/sensor.my_special_sensor
Google Apps Script returns a 400 Bad Request error.
var HOME_ASSISTANT_TOKEN = "longFunkyCodeLikeThisiJ9.eyJpc3Mijk5fQ.0Fpw8I"
var HOME_ASSISTANT_URL = "https://mydevice.duckdns.org:8123/api/"
function testTemp() {
console.log(getDeviceParameters('sensor.my_special_sensor'));
}
function getDeviceParameters(id) {
var url = HOME_ASSISTANT_URL + "states/" + id;
Logger.log(url);
var bearer = "Bearer " + HOME_ASSISTANT_TOKEN;
var headers = {
"Authorization": bearer,
"Content-Type": 'application/json',
};
var params = {
method: 'get',
headers: headers
};
return UrlFetchApp.fetch(url, params ).getContentText();
}
What am I doing wrong?
It seems Google Apps Script may be blocking port 8123. The script functions by using by instead using your nabu casa url which operates out of port 80.
Just change the HOME_ASSISTANT_URL value to https://[yourspecialcode].ui.nabu.casa/api/

botmaker API post JSON google sheet script

I have google sheet with data that I need to send using WhatsApp, so I have the API of Botmaker. They give a cURL and JSON data but I do not know how to use the cURL and JSON to do the post usen a google scrip function.
This is the cURL:
curl
- X POST
--header 'Content-Type: multipart/form-data'
--header 'Accept: application/json'
--header 'access-token: myAccessToken'
-F chatPlatform=whatsapp
-F chatChannelNumber=############
-F platformContactId=############
-F mediaType=document
This is the Request URL of the API: 'https://go.botmaker.com/api/v1.0/message/binary/v3'
This is the Response Body:
no content
This the Response Code:
401
Response Headers:
{
"accept": "[application/json, application/xml, text/plain]",
"access-control-allow-credentials": "true",
"access-control-allow-headers": "bearer-token,access-token,Content-Type,Authorization,X-Requested-With,Content-Length,Accept,Origin",
"access-control-allow-methods": "GET, POST, PUT, DELETE, OPTIONS, HEAD",
"access-control-allow-origin": "https://go.botmaker.com",
"alt-svc": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000",
"cache-control": "must-revalidate,no-cache,no-store",
"content-length": "0",
"content-security-policy": "default-src 'self'",
"date": "Sat, 11 Jun 2022 22:52:02 GMT",
"permissions-policy": "geolocation=(self \"https://go.botmaker.com\"), microphone=()",
"reason-phrase": "Cannot authenticate user with received tokens after applying [access-token] and accessToken [null]",
"referrer-policy": "no-referrer",
"server": "Botmaker",
"strict-transport-security": "max-age=31536000; includeSubDomains",
"via": "1.1 google",
"x-content-type-options": "nosniff",
"x-frame-options": "DENY"
}
I understand that I need to use the UrlFetchApp.fetch
Someone can help me to create
I found the way, here is how it works for me:
var userNumber = '123456789012' // to: cellular phone number
const waNumber = '123456789012'; // from: cellular phone
const accessToken = 'faketoken'; // use you token
// send a template
var url = 'https://go.botmaker.com/api/v1.0/intent/v2';
var headers = {
'Content-Type': 'application/json' ,
'Accept': 'application/json' ,
'access-token': accessToken
};
var dataJson = {
"chatPlatform": "whatsapp",
"chatChannelNumber": waNumber,
"platformContactId": userNumber,
"ruleNameOrId": "template_name" // the name of the template
};
var payload = JSON.stringify(dataJson);
var options = {
'method': 'POST',
'headers': headers,
'payload': payload
};
var response = UrlFetchApp.fetch(url, options);
Logger.log(response);

Google Apps Script UrlFetchApp.fetch converts integers to floats?

I am writing a Google App Script that accesses several APIs using UrlFetchApp
One of my API POST requests expects an integer value in the payload, but UrlFetchApp.fetch changes the integer value (i.e. 0) to a float (i.e. 0.0)
My options look something like this:
const options = { method: 'POST', headers: {...}, payload: { someStringA: "foo", someStringB: "bar", App: 0 } }
And the error msg returned from the API is:
{"message":"The request is invalid.","modelState":{"request.App":["The value '0.0' is not valid for App.","The App field is required."]}}
UrlFetchApp.fetch has converted my App value of: 0 to: 0.0 which this API endpoint does not accept.
I tried forcing the request value to a string "0" instead, but the API does not accept a string type for that property.
Does anyone know of a workaround for this? How can I tell UrlFetchApp.fetch to keep integer values "as is" and not convert them to floats?
ps. the same request works ok for me via cURL like this:
curl --location --request POST "https://$url" \
--header 'Content-Type: application/json' \
--header "Authorization: Bearer $token" \
--data "{\"someStringA\":\"$foo\",\"someStringB\":\"$bar\",\"app\":0}"
Thanks in advance for any assistance
UPDATE: apologies, but the problem here was not with UrlFetchApp after all. My problem was that the response coming back from the api was an empty object and I was trying to log it like this: JSON.parse(response); resulting in the errors mentioned.
From your question, unfortunately, I'm not sure about the specification of the API you want to use, your request header and your curl command you confirmed. So I would like to propose the following modification patterns as my guess.
From:
const options = { method: 'POST', headers: {...}, payload: { someStringA: "foo", someStringB: "bar", App: 0 } }
To: pattern 1
const options = { method: 'POST', headers: {...}, contentType: "application/json", payload: JSON.stringify({ someStringA: "foo", someStringB: "bar", App: 0 }) };
In this case, the data is sent as JSON.
If you are using Content-Type in headers, please remove it.
To: pattern 2
const options = { method: 'POST', headers: {...}, payload: JSON.stringify({ someStringA: "foo", someStringB: "bar", App: 0 }) };
In this case, the data is sent as form data of the string value.
To: pattern 3
const options = { method: 'POST', headers: {...}, payload: { someStringA: "foo", someStringB: "bar", App: "0" } };
In this case, "0" is sent as a string value of form data in the parsed data.
Note:
If above modification patterns were not the solution of your issue, can you provide your sample curl command that you confirmed? By this, I would like to modify my answer.
Reference:
Class UrlFetchApp
Added:
From your curl command, I understood that my pattern 1 is the same request with your curl command. But from Unexpected end of JSON input of your replying, unfortunately, although I'm not sure about your current script using my pattern 1, when your curl command is converted to Google Apps Script, it becomes as follows. Can you test it again?
const token = "###"; // Please use your token.
const data = { someStringA: "foo", someStringB: "bar", App: 0 };
const options = {
method: 'POST',
headers: { Authorization: `Bearer ${token}` },
contentType: "application/json",
payload: JSON.stringify(data)
};
const res = UrlFetchApp.fetch("your URL", options);
console.log(res.getContentText())

GAS: Error 401 while connecting to an API

I'm trying to connect to Cloud Waitress API, a solution for restaurants,
Documentation: https://apidocs.cloudwaitress.com/#orderpromos
It's documentation gives an example on how to connect to the API:
curl https://api.cloudwaitress.com/v1/orders \
-X POST \
-H "Content-Type: application/json" \
-H "Authorization: YOUR_API_KEY" \
-d `
{
"restaurant_id": "xxxxxxx",
"limit": 10,
"page": 1,
"sort": { "created": -1 },
}
I tried to create a Script in GAS to get the information back to a Spreadsheet.
Based on this question:
How curl maps onto Google App Script URLFetchApp
I have changed my code as follows:
function getAuthHeader(){
var apiKey = "SOME-API-KEY";
var authHeader = Utilities.base64Encode(apiKey);
return {
headers: {Authorization: authHeader}
}
}
function GetOrders(){
var url = "https://api.cloudwaitress.com/v1/orders";
var data = {
"restaurant_id":"SOME-RESTAURANT-ID",
"limit": 10,
"page": 1,
"sort": { "created": 1 }
};
var result = goPost(url ,data);
}
function goPost(url,data){
var options = {
'method' : 'post',
'payload' : data,
'headers': getAuthHeader()['headers']
};
var response;
try{
response = JSON.parse(UrlFetchApp.fetch(url,options).getContentText());
}catch(err){
Logger.log(err);
}
return response;
}
Right now the new error that I'm getting is:
Exception: Request failed for https://api.cloudwaitress.com returned
code 401. Truncated server response: {"outcome":1,"message":"Invalid
Authentication"} (use muteHttpExceptions option to examine full
response)
Which I believe is quite a progress since I was getting an 500 error before.
I have asked the cloudwaitress team their assistance, however I wonder if there is something else I can try.
How about this modification?
Modification points:
At your sample curl, "Content-Type: application/json" is used, and the JSON object is converted to the string.
The thread you refered uses the basic authorization like -u testtoken123:. By this, Utilities.base64Encode is required be used. But in your sample curl, the API key is directly used.
I thought that this might be the reason of the error message.
When above points are reflected to your script, it becomes as follows.
Modified script:
From:
var options = {
'method' : 'post',
'payload' : data,
'headers': getAuthHeader()['headers']
};
To:
var apiKey = "SOME-API-KEY";
var options = {
'method' : 'post',
'payload' : JSON.stringify(data),
'headers': {Authorization: apiKey},
'contentType': "application/json",
};
In this case, getAuthHeader() is not used.
Note:
The request of this modified script is the same with your sample curl command. But in this modified script, it supposes that your apiKey and data can be used for this API. Please be careful this.
Reference:
Class UrlFetchApp

Can not create folder using multipart

I always get:
Missing end boundary in multipart body.
API Sandbox doesn't help. It is possible to create folder there.
The request is:
curl https://www.googleapis.com/upload/drive/v3/files?uploadType=multipart -d #/home/payload -H 'Authorization: Bearer mytoken' -H 'Content-Type: multipart/boundary; boundary=RubyApiClientUpload'
The payload is:
--RubyApiClientUpload
Content-Type: application/json
{ "mimeType":"application/vnd.google-apps.folder", "name":"newfolder", "parents":["0AMtAREF....."] }
--RubyApiClientUpload
--RubyApiClientUpload--
You're using the wrong API call. A folder has no content, so you create it by POSTing to the URL in https://developers.google.com/drive/v3/reference/files/create
You can easily test it at https://developers.google.com/drive/v3/reference/files/create#try-it where you should see
POST https://www.googleapis.com/drive/v3/files?key={YOUR_API_KEY}
{
"mimeType": "application/vnd.google-apps.folder",
"name": "test folder"
}
This code works for me.
const body = JSON.stringify({
name: "Super folder!!!",
mimeType: "application/vnd.google-apps.folder"
});
const headers = new Headers();
headers.append("Authorization", `Bearer ${accessToken}`);
headers.append("Content-Type", "application/json");
headers.append("Content-Length", body.length);
fetch(
"https://www.googleapis.com/drive/v3/files", {
method: "POST",
headers,
body
});