Foxpro / Postman API / API Key Owner
Back to Collection Items
LOCAL loHttp
LOCAL lnSuccess
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcName
LOCAL lnLimit
LOCAL lnUsage
LOCAL lnOverage
LOCAL lcId
LOCAL lcUsername
LOCAL lcV_Email
LOCAL lcFullName
LOCAL lcAvatar
LOCAL lnIsPublic
LOCAL i
LOCAL lnCount_i
* This example assumes the Chilkat API to have been previously unlocked.
* See Global Unlock Sample for sample code.
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')
loHttp.SetRequestHeader("X-API-Key","{{postman_api_key}}")
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbResponseBody = CreateObject('Chilkat.StringBuilder')
lnSuccess = loHttp.QuickGetSb("https://api.getpostman.com/me",loSbResponseBody)
IF (lnSuccess = 0) THEN
? loHttp.LastErrorText
RELEASE loHttp
RELEASE loSbResponseBody
CANCEL
ENDIF
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJResp = CreateObject('Chilkat.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loHttp.LastStatus
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
? "Response Header:"
? loHttp.LastHeader
? "Failed."
RELEASE loHttp
RELEASE loSbResponseBody
RELEASE loJResp
CANCEL
ENDIF
* Sample JSON response:
* (Sample code for parsing the JSON response is shown below)
* {
* "user": {
* "id": "631643",
* "username": "janedoe",
* "email": "janedoe@example.com",
* "fullName": "Jane Doe",
* "avatar": "https://www.gravatar.com/avatar/e1f3994f2632af3d1c8c2dcc168a10e6",
* "isPublic": false
* },
* "operations": [
* {
* "name": "mock_usage",
* "limit": 1000000,
* "usage": 2382,
* "overage": 0
* },
* {
* "name": "monitor_request_runs",
* "limit": 10000000,
* "usage": 49492,
* "overage": 0
* },
* {
* "name": "documenter_public_views",
* "limit": 5000000,
* "usage": 120232,
* "overage": 0
* },
* {
* "name": "api_usage",
* "limit": 1000000,
* "usage": 1345,
* "overage": 0
* },
* {
* "name": "custom_domains",
* "limit": 25,
* "usage": 1,
* "overage": 0
* },
* {
* "name": "custom_authentication_methods",
* "limit": 1,
* "usage": 1,
* "overage": 0
* },
* {
* "name": "serverless_requests",
* "limit": 10000,
* "usage": 0,
* "overage": 0
* },
* {
* "name": "integrations",
* "limit": 5000,
* "usage": 145,
* "overage": 0
* },
* {
* "name": "cloud_agent_requests",
* "limit": 1000000,
* "usage": 23823,
* "overage": 0
* }
* ]
* }
* Sample code for parsing the JSON response...
* Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
lcId = loJResp.StringOf("user.id")
lcUsername = loJResp.StringOf("user.username")
lcV_Email = loJResp.StringOf("user.email")
lcFullName = loJResp.StringOf("user.fullName")
lcAvatar = loJResp.StringOf("user.avatar")
lnIsPublic = loJResp.BoolOf("user.isPublic")
i = 0
lnCount_i = loJResp.SizeOfArray("operations")
DO WHILE i < lnCount_i
loJResp.I = i
lcName = loJResp.StringOf("operations[i].name")
lnLimit = loJResp.IntOf("operations[i].limit")
lnUsage = loJResp.IntOf("operations[i].usage")
lnOverage = loJResp.IntOf("operations[i].overage")
i = i + 1
ENDDO
RELEASE loHttp
RELEASE loSbResponseBody
RELEASE loJResp
Curl Command
curl -X GET
-H "X-API-Key: {{postman_api_key}}"
https://api.getpostman.com/me
Postman Collection Item JSON
{
"name": "API Key Owner",
"event": [
{
"listen": "test",
"script": {
"type": "text/javascript",
"exec": [
"var responseJSON;",
"",
"// parse response body as JSON",
"try { responseJSON = JSON.parse(responseBody); } catch (e) { }",
"tests['received a valid response JSON'] = !!responseJSON;",
"!responseJSON && (responseJSON = {});",
"",
"tests['status code is 200'] = (responseCode.code === 200);",
"tests['response does not have errors'] = (!responseJSON.error);",
"",
"tests['response has a user object'] = (typeof responseJSON.user === 'object');",
"tests['response user object has id'] = (responseJSON.user && responseJSON.user.id);"
]
}
}
],
"request": {
"method": "GET",
"header": [
],
"url": {
"raw": "https://api.getpostman.com/me",
"protocol": "https",
"host": [
"api",
"getpostman",
"com"
],
"path": [
"me"
]
},
"description": "the `/me` Postman API endpoint lets you access information about the authenticated user. You can retrieve the authenticated user's username, full name, e-mail address, and any other available information.\n\n> Requires <a href=\"#authentication\">API Key</a> as `X-Api-Key` request header or `apikey` URL query parameter."
},
"response": [
{
"name": "Valid Response",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "https://api.getpostman.com/me",
"protocol": "https",
"host": [
"api",
"getpostman",
"com"
],
"path": [
"me"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"name": "Content-Type",
"description": {
"content": "",
"type": "text/plain"
}
}
],
"cookie": [
],
"body": "{\n \"user\": {\n \"id\": \"631643\",\n \"username\": \"janedoe\",\n \"email\": \"janedoe@example.com\",\n \"fullName\": \"Jane Doe\",\n \"avatar\": \"https://www.gravatar.com/avatar/e1f3994f2632af3d1c8c2dcc168a10e6\",\n \"isPublic\": false\n },\n \"operations\": [\n {\n \"name\": \"mock_usage\",\n \"limit\": 1000000,\n \"usage\": 2382,\n \"overage\": 0\n },\n {\n \"name\": \"monitor_request_runs\",\n \"limit\": 10000000,\n \"usage\": 49492,\n \"overage\": 0\n },\n {\n \"name\": \"documenter_public_views\",\n \"limit\": 5000000,\n \"usage\": 120232,\n \"overage\": 0\n },\n {\n \"name\": \"api_usage\",\n \"limit\": 1000000,\n \"usage\": 1345,\n \"overage\": 0\n },\n {\n \"name\": \"custom_domains\",\n \"limit\": 25,\n \"usage\": 1,\n \"overage\": 0\n },\n {\n \"name\": \"custom_authentication_methods\",\n \"limit\": 1,\n \"usage\": 1,\n \"overage\": 0\n },\n {\n \"name\": \"serverless_requests\",\n \"limit\": 10000,\n \"usage\": 0,\n \"overage\": 0\n },\n {\n \"name\": \"integrations\",\n \"limit\": 5000,\n \"usage\": 145,\n \"overage\": 0\n },\n {\n \"name\": \"cloud_agent_requests\",\n \"limit\": 1000000,\n \"usage\": 23823,\n \"overage\": 0\n }\n ]\n}"
}
]
}
