Chilkat Online Tools

SQL Server / Broker API / Authorize an OAuth Token

Back to Collection Items

-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
    DECLARE @hr int
    DECLARE @iTmp0 int
    -- Important: Do not use nvarchar(max).  See the warning about using nvarchar(max).
    DECLARE @sTmp0 nvarchar(4000)
    -- This example assumes the Chilkat API to have been previously unlocked.
    -- See Global Unlock Sample for sample code.

    DECLARE @http int
    -- Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.Http', @http OUT
    IF @hr <> 0
    BEGIN
        PRINT 'Failed to create ActiveX component'
        RETURN
    END

    DECLARE @success int

    EXEC sp_OASetProperty @http, 'BasicAuth', 1
    EXEC sp_OASetProperty @http, 'Login', '{{api_key}}'
    EXEC sp_OASetProperty @http, '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}"
    -- }

    DECLARE @json int
    -- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @json OUT

    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'client_id', '7a3c52a910e1dc2abbb14da2b6b8e711'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'client_secret', '{client_secret}'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'redirect_uri', 'www.example.com/oauth_redirect'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'scope', 'general'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'account_id', '{account_id}'

    DECLARE @resp int
    EXEC sp_OAMethod @http, 'PostJson3', @resp OUT, 'https://domain.com/v1/oauth/authorize', 'application/json', @json
    EXEC sp_OAGetProperty @http, 'LastMethodSuccess', @iTmp0 OUT
    IF @iTmp0 = 0
      BEGIN
        EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @http
        EXEC @hr = sp_OADestroy @json
        RETURN
      END

    EXEC sp_OAGetProperty @resp, 'StatusCode', @iTmp0 OUT
    PRINT @iTmp0
    EXEC sp_OAGetProperty @resp, 'BodyStr', @sTmp0 OUT
    PRINT @sTmp0
    EXEC @hr = sp_OADestroy @resp


    EXEC @hr = sp_OADestroy @http
    EXEC @hr = sp_OADestroy @json


END
GO

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": [
  ]
}