ringcentral.postman2.base.json

{
	"variables": [],
	"info": {
		"name": "RingCentral REST API",
		"description": "This is a collection of API requests associated with the Basic usage plan in RingCentral Connect Platform for Sandbox Testing.\n\nPlease use a Postman environment with the following variables: RC_SERVER_HOSTNAME, RC_APP_KEY, RC_APP_SECRET, RC_USERNAME, RC_EXTENSION, RC_PASSWORD\n\nTo use these resources, you must ALWAYS start by executing one of the OAuth \"Auth\" Requests first, then you can use any other requests (for the 60 minutes that the access_token you obtained is valid).",
		"schema": "https://schema.getpostman.com/json/collection/v2.0.0/collection.json"
	},
	"item": [
		{
			"name": "Auth",
			"description": "YOU MUST UPDATE VALUES IN THE \"Pre-request Script\" section of ALL items in this folder to match your RingCentral Sandbox Account.",
			"item": [
				{
					"name": "Fetch access_token",
					"event": [
						{
							"listen": "test",
							"script": {
								"type": "text/javascript",
								"exec": [
									"var jsonData = JSON.parse(responseBody);",
									"tests[\"Contains an access_token\"] = jsonData.hasOwnProperty('access_token');",
									"",
									"tests[\"Status code is 200\"] = responseCode.code === 200;",
									"",
									"postman.setEnvironmentVariable(\"my_access_token\", jsonData.access_token);"
								]
							}
						},
						{
							"listen": "prerequest",
							"script": {
								"type": "text/javascript",
								"exec": [
									"// Populate the Postman environment with:",
									"// RINGCENTRAL_SERVER_URL, RINGCENTRAL_CLIENT_ID, RINGCENTRAL_CLIENT_SECRET,",
									"// RINGCENTRAL_USERNAME, RINGCENTRAL_EXTENSION, RINGCENTRAL_PASSWORD",
									"var appKey = environment[\"RINGCENTRAL_CLIENT_ID\"];",
									"var appSecret = environment[\"RINGCENTRAL_CLIENT_SECRET\"];",
									"var apiKey = encodeBasicAuthHeader(appKey, appSecret);",
									"",
									"postman.setEnvironmentVariable(\"basic_auth_header\", \"Basic \".concat(apiKey));",
									"",
									"function encodeBasicAuthHeader(appKey, appSecret) {",
									"    var apiKey = appKey + ':' + appSecret;",
									"    return btoa(apiKey);",
									"}"
								]
							}
						}
					],
					"request": {
						"url": {
							"raw": "{{RINGCENTRAL_SERVER_URL}}/restapi/oauth/token",
							"auth": null,
							"host": [
								"{{RINGCENTRAL_SERVER_URL}}"
							],
							"path": [
								"restapi",
								"oauth",
								"token"
							]
						},
						"method": "POST",
						"header": [
							{
								"key": "Authorization",
								"value": "{{basic_auth_header}}",
								"description": ""
							},
							{
								"key": "Accept",
								"value": "application/json",
								"description": ""
							},
							{
								"key": "Content-Type",
								"value": "application/x-www-form-urlencoded;charset=UTF-8",
								"description": ""
							}
						],
						"body": {
							"mode": "urlencoded",
							"urlencoded": [
								{
									"key": "grant_type",
									"value": "password",
									"type": "text",
									"enabled": true
								},
								{
									"key": "username",
									"value": "{{RINGCENTRAL_USERNAME}}",
									"type": "text",
									"enabled": true
								},
								{
									"key": "password",
									"value": "{{RINGCENTRAL_PASSWORD}}",
									"type": "text",
									"enabled": true
								},
								{
									"key": "extension",
									"value": "{{RINGCENTRAL_EXTENSION}}",
									"type": "text",
									"enabled": true
								}
							]
						},
						"description": "Fetch access_token from DevTest environment as Admin"
					},
					"response": []
				}
			]
		}
	]
}