Skip to content

OAuthApi.md

Latest commit

 

History

History
136 lines (89 loc) · 3.88 KB

OAuthApi.md

File metadata and controls

136 lines (89 loc) · 3.88 KB
Raw

Dropbox\Sign\OAuthApi

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

Method HTTP request Description
oauthTokenGenerate() POST /oauth/token OAuth Token Generate
oauthTokenRefresh() POST /oauth/token?refresh OAuth Token Refresh

oauthTokenGenerate()

oauthTokenGenerate($o_auth_token_generate_request): \Dropbox\Sign\Model\OAuthTokenResponse

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.

Example

<?php

namespace Dropbox\SignSandbox;

require_once __DIR__ . '/../vendor/autoload.php';

use SplFileObject;
use Dropbox;

$config = Dropbox\Sign\Configuration::getDefaultConfiguration();

$o_auth_token_generate_request = (new Dropbox\Sign\Model\OAuthTokenGenerateRequest())
    ->setClientId("cc91c61d00f8bb2ece1428035716b")
    ->setClientSecret("1d14434088507ffa390e6f5528465")
    ->setCode("1b0d28d90c86c141")
    ->setState("900e06e2")
    ->setGrantType("authorization_code");

try {
    $response = (new Dropbox\Sign\Api\OAuthApi(config: $config))->oauthTokenGenerate(
        o_auth_token_generate_request: $o_auth_token_generate_request,
    );

    print_r($response);
} catch (Dropbox\Sign\ApiException $e) {
    echo "Exception when calling OAuthApi#oauthTokenGenerate: {$e->getMessage()}";
}

Parameters

Name Type Description Notes
o_auth_token_generate_request \Dropbox\Sign\Model\OAuthTokenGenerateRequest

Return type

\Dropbox\Sign\Model\OAuthTokenResponse

Authorization

No authorization required

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

oauthTokenRefresh()

oauthTokenRefresh($o_auth_token_refresh_request): \Dropbox\Sign\Model\OAuthTokenResponse

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.

Example

<?php

namespace Dropbox\SignSandbox;

require_once __DIR__ . '/../vendor/autoload.php';

use SplFileObject;
use Dropbox;

$config = Dropbox\Sign\Configuration::getDefaultConfiguration();

$o_auth_token_refresh_request = (new Dropbox\Sign\Model\OAuthTokenRefreshRequest())
    ->setGrantType("refresh_token")
    ->setRefreshToken("hNTI2MTFmM2VmZDQxZTZjOWRmZmFjZmVmMGMyNGFjMzI2MGI5YzgzNmE3");

try {
    $response = (new Dropbox\Sign\Api\OAuthApi(config: $config))->oauthTokenRefresh(
        o_auth_token_refresh_request: $o_auth_token_refresh_request,
    );

    print_r($response);
} catch (Dropbox\Sign\ApiException $e) {
    echo "Exception when calling OAuthApi#oauthTokenRefresh: {$e->getMessage()}";
}

Parameters

Name Type Description Notes
o_auth_token_refresh_request \Dropbox\Sign\Model\OAuthTokenRefreshRequest

Return type

\Dropbox\Sign\Model\OAuthTokenResponse

Authorization

No authorization required

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]