All URIs are relative to https://connect.squareup.com
| Method | HTTP request | Description |
|---|---|---|
| obtainToken | POST /oauth2/token | ObtainToken |
| renewToken | POST /oauth2/clients/{client_id}/access-token/renew | RenewToken |
| revokeToken | POST /oauth2/revoke | RevokeToken |
\SquareConnect\Model\ObtainTokenResponse obtainToken($body)
ObtainToken
Returns an OAuth access token. The endpoint supports distinct methods of obtaining OAuth access tokens. Applications specify a method by adding the grant_type parameter in the request and also provide relevant information. For more information, see OAuth access token management. Note: Regardless of the method application specified, the endpoint always returns two items; an OAuth access token and a refresh token in the response. OAuth tokens should only live on secure servers. Application clients should never interact directly with OAuth tokens.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new SquareConnect\Api\OAuthApi();
$body = new \SquareConnect\Model\ObtainTokenRequest(); // \SquareConnect\Model\ObtainTokenRequest | An object containing the fields to POST for the request. See the corresponding object definition for field details.
try {
$result = $apiInstance->obtainToken($body);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling OAuthApi->obtainToken: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| body | \SquareConnect\Model\ObtainTokenRequest | An object containing the fields to POST for the request. See the corresponding object definition for field details. |
\SquareConnect\Model\ObtainTokenResponse
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Note: This endpoint is deprecated.
\SquareConnect\Model\RenewTokenResponse renewToken($client_id, $body)
RenewToken
RenewToken is deprecated. For information about refreshing OAuth access tokens, see Renew OAuth Token. Renews an OAuth access token before it expires. OAuth access tokens besides your application's personal access token expire after 30 days. You can also renew expired tokens within 15 days of their expiration. You cannot renew an access token that has been expired for more than 15 days. Instead, the associated user must re-complete the OAuth flow from the beginning. Important: The Authorization header for this endpoint must have the following format: Authorization: Client APPLICATION_SECRET Replace APPLICATION_SECRET with the application secret on the Credentials page in the application dashboard.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: oauth2ClientSecret
$config = SquareConnect\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = SquareConnect\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');
$apiInstance = new SquareConnect\Api\OAuthApi();
$client_id = "client_id_example"; // string | Your application ID, available from the [application dashboard](https://connect.squareup.com/apps).
$body = new \SquareConnect\Model\RenewTokenRequest(); // \SquareConnect\Model\RenewTokenRequest | An object containing the fields to POST for the request. See the corresponding object definition for field details.
try {
$result = $apiInstance->renewToken($client_id, $body);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling OAuthApi->renewToken: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| client_id | string | Your application ID, available from the application dashboard. | |
| body | \SquareConnect\Model\RenewTokenRequest | An object containing the fields to POST for the request. See the corresponding object definition for field details. |
\SquareConnect\Model\RenewTokenResponse
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\SquareConnect\Model\RevokeTokenResponse revokeToken($body)
RevokeToken
Revokes an access token generated with the OAuth flow. If an account has more than one OAuth access token for your application, this endpoint revokes all of them, regardless of which token you specify. When an OAuth access token is revoked, all of the active subscriptions associated with that OAuth token are canceled immediately. Important: The Authorization header for this endpoint must have the following format: Authorization: Client APPLICATION_SECRET Replace APPLICATION_SECRET with the application secret on the Credentials page in the application dashboard.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: oauth2ClientSecret
$config = SquareConnect\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = SquareConnect\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');
$apiInstance = new SquareConnect\Api\OAuthApi();
$body = new \SquareConnect\Model\RevokeTokenRequest(); // \SquareConnect\Model\RevokeTokenRequest | An object containing the fields to POST for the request. See the corresponding object definition for field details.
try {
$result = $apiInstance->revokeToken($body);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling OAuthApi->revokeToken: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| body | \SquareConnect\Model\RevokeTokenRequest | An object containing the fields to POST for the request. See the corresponding object definition for field details. |
\SquareConnect\Model\RevokeTokenResponse
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]