Skip to content

OAuthApi.md

Latest commit

 

History

History
154 lines (103 loc) · 4.31 KB

OAuthApi.md

File metadata and controls

154 lines (103 loc) · 4.31 KB

Dropbox::Sign::OAuthApi

All URIs are relative to https://api.hellosign.com/v3

Method HTTP request Description
oauth_token_generate POST /oauth/token OAuth Token Generate
oauth_token_refresh POST /oauth/token?refresh OAuth Token Refresh

oauth_token_generate

<OAuthTokenResponse> oauth_token_generate(o_auth_token_generate_request)

OAuth Token Generate

Once you have retrieved the code from the user callback, you will need to exchange it for an access token via a backend call.

Examples

require "json"
require "dropbox-sign"

Dropbox::Sign.configure do |config|
end

o_auth_token_generate_request = Dropbox::Sign::OAuthTokenGenerateRequest.new
o_auth_token_generate_request.client_id = "cc91c61d00f8bb2ece1428035716b"
o_auth_token_generate_request.client_secret = "1d14434088507ffa390e6f5528465"
o_auth_token_generate_request.code = "1b0d28d90c86c141"
o_auth_token_generate_request.state = "900e06e2"
o_auth_token_generate_request.grant_type = "authorization_code"

begin
  response = Dropbox::Sign::OAuthApi.new.oauth_token_generate(
    o_auth_token_generate_request,
  )

  p response
rescue Dropbox::Sign::ApiError => e
  puts "Exception when calling OAuthApi#oauth_token_generate: #{e}"
end

Using the oauth_token_generate_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(<OAuthTokenResponse>, Integer, Hash)> oauth_token_generate_with_http_info(o_auth_token_generate_request)

begin
  # OAuth Token Generate
  data, status_code, headers = api_instance.oauth_token_generate_with_http_info(o_auth_token_generate_request)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <OAuthTokenResponse>
rescue Dropbox::Sign::ApiError => e
  puts "Error when calling OAuthApi->oauth_token_generate_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
o_auth_token_generate_request OAuthTokenGenerateRequest

Return type

OAuthTokenResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

oauth_token_refresh

<OAuthTokenResponse> oauth_token_refresh(o_auth_token_refresh_request)

OAuth Token Refresh

Access tokens are only valid for a given period of time (typically one hour) for security reasons. Whenever acquiring an new access token its TTL is also given (see expires_in), along with a refresh token that can be used to acquire a new access token after the current one has expired.

Examples

require "json"
require "dropbox-sign"

Dropbox::Sign.configure do |config|
end

o_auth_token_refresh_request = Dropbox::Sign::OAuthTokenRefreshRequest.new
o_auth_token_refresh_request.grant_type = "refresh_token"
o_auth_token_refresh_request.refresh_token = "hNTI2MTFmM2VmZDQxZTZjOWRmZmFjZmVmMGMyNGFjMzI2MGI5YzgzNmE3"

begin
  response = Dropbox::Sign::OAuthApi.new.oauth_token_refresh(
    o_auth_token_refresh_request,
  )

  p response
rescue Dropbox::Sign::ApiError => e
  puts "Exception when calling OAuthApi#oauth_token_refresh: #{e}"
end

Using the oauth_token_refresh_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(<OAuthTokenResponse>, Integer, Hash)> oauth_token_refresh_with_http_info(o_auth_token_refresh_request)

begin
  # OAuth Token Refresh
  data, status_code, headers = api_instance.oauth_token_refresh_with_http_info(o_auth_token_refresh_request)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <OAuthTokenResponse>
rescue Dropbox::Sign::ApiError => e
  puts "Error when calling OAuthApi->oauth_token_refresh_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
o_auth_token_refresh_request OAuthTokenRefreshRequest

Return type

OAuthTokenResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json