Chilkat Online Tools

Ruby / Broker API / Authorize an OAuth Token

Back to Collection Items

require 'chilkat'

# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

http = Chilkat::CkHttp.new()

http.put_BasicAuth(true)
http.put_Login("{{api_key}}")
http.put_Password("{{api_secret}}")

# Use this online tool to generate code from sample JSON: Generate Code to Create JSON

# The following JSON is sent in the request body.

# {
#   "client_id": "7a3c52a910e1dc2abbb14da2b6b8e711",
#   "client_secret": "{client_secret}",
#   "redirect_uri": "www.example.com/oauth_redirect",
#   "scope": "general",
#   "account_id": "{account_id}"
# }

json = Chilkat::CkJsonObject.new()
json.UpdateString("client_id","7a3c52a910e1dc2abbb14da2b6b8e711")
json.UpdateString("client_secret","{client_secret}")
json.UpdateString("redirect_uri","www.example.com/oauth_redirect")
json.UpdateString("scope","general")
json.UpdateString("account_id","{account_id}")

# resp is a CkHttpResponse
resp = http.PostJson3("https://domain.com/v1/oauth/authorize","application/json",json)
if (http.get_LastMethodSuccess() == false)
    print http.lastErrorText() + "\n";
    exit
end

print resp.get_StatusCode().to_s() + "\n";
print resp.bodyStr() + "\n";

Curl Command

curl -X POST
	-u '{{api_key}}:{{api_secret}}'
	-d '{
  "client_id": "7a3c52a910e1dc2abbb14da2b6b8e711",
  "client_secret": "{client_secret}",
  "redirect_uri": "www.example.com/oauth_redirect",
  "scope": "general",
  "account_id": "{account_id}"
}'
https://domain.com/v1/oauth/authorize

Postman Collection Item JSON

{
  "name": "Authorize an OAuth Token",
  "request": {
    "method": "POST",
    "header": [
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"client_id\": \"7a3c52a910e1dc2abbb14da2b6b8e711\",\n  \"client_secret\": \"{client_secret}\",\n  \"redirect_uri\": \"www.example.com/oauth_redirect\",\n  \"scope\": \"general\",\n  \"account_id\": \"{account_id}\"\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{HOST}}/v1/oauth/authorize",
      "host": [
        "{{HOST}}"
      ],
      "path": [
        "v1",
        "oauth",
        "authorize"
      ]
    },
    "description": "| Attribute         | Type           | Requirement                           | Notes                          |\n| ----------------- | -------------- | ------------------------------------- | ------------------------------ |\n| `client_id`       | string         | Required | OAuth `client_id`               |\n| `client_secret`   | string         | Required | OAuth `client_secret`            |\n| `redirect_uri`    | string         | Required | Redirect URI of OAuth flow     |\n| `scope`          | string/numeric | Required | Requested scopes by OAuth flow |\n| `account_id`      | string         | Required | UUID of end user               |"
  },
  "response": [
  ]
}