VB.NET / Postman API / API Key Owner
Back to Collection Items
' This example assumes the Chilkat API to have been previously unlocked.
' See Global Unlock Sample for sample code.
Dim http As New Chilkat.Http
Dim success As Boolean
http.SetRequestHeader("X-API-Key","{{postman_api_key}}")
Dim sbResponseBody As New Chilkat.StringBuilder
success = http.QuickGetSb("https://api.getpostman.com/me",sbResponseBody)
If (success = False) Then
Debug.WriteLine(http.LastErrorText)
Exit Sub
End If
Dim jResp As New Chilkat.JsonObject
jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False
Debug.WriteLine("Response Body:")
Debug.WriteLine(jResp.Emit())
Dim respStatusCode As Integer = http.LastStatus
Debug.WriteLine("Response Status Code = " & respStatusCode)
If (respStatusCode >= 400) Then
Debug.WriteLine("Response Header:")
Debug.WriteLine(http.LastHeader)
Debug.WriteLine("Failed.")
Exit Sub
End If
' 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
Dim name As String
Dim limit As Integer
Dim usage As Integer
Dim overage As Integer
Dim Id As String = jResp.StringOf("user.id")
Dim Username As String = jResp.StringOf("user.username")
Dim v_Email As String = jResp.StringOf("user.email")
Dim FullName As String = jResp.StringOf("user.fullName")
Dim Avatar As String = jResp.StringOf("user.avatar")
Dim IsPublic As Boolean = jResp.BoolOf("user.isPublic")
Dim i As Integer = 0
Dim count_i As Integer = jResp.SizeOfArray("operations")
While i < count_i
jResp.I = i
name = jResp.StringOf("operations[i].name")
limit = jResp.IntOf("operations[i].limit")
usage = jResp.IntOf("operations[i].usage")
overage = jResp.IntOf("operations[i].overage")
i = i + 1
End While
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}"
}
]
}
