OAuthApi.md

SquareConnect.OAuthApi

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

obtainToken

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. 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.

Example

var SquareConnect = require('square-connect');

var apiInstance = new SquareConnect.OAuthApi();

var body = SquareConnect.OAuthApi.constructFromObject({}); // ObtainTokenRequest | An object containing the fields to POST for the request.  See the corresponding object definition for field details.

apiInstance.obtainToken(body).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
body	ObtainTokenRequest	An object containing the fields to POST for the request. See the corresponding object definition for field details.

Return type

ObtainTokenResponse

Authorization

No authorization required

HTTP request headers

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

renewToken

Note: This endpoint is deprecated.

RenewTokenResponse renewToken(clientId, 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.

Example

var SquareConnect = require('square-connect');
var defaultClient = SquareConnect.ApiClient.instance;

// Configure API key authorization: oauth2ClientSecret
var oauth2ClientSecret = defaultClient.authentications['oauth2ClientSecret'];
oauth2ClientSecret.apiKey = 'APPLICATION SECRET';
oauth2ClientSecret.apiKeyPrefix = 'Client';

var apiInstance = new SquareConnect.OAuthApi();

var clientId = SquareConnect.OAuthApi.constructFromObject({}); // String | Your application ID, available from the [application dashboard](https://connect.squareup.com/apps).

var body = SquareConnect.OAuthApi.constructFromObject({}); // RenewTokenRequest | An object containing the fields to POST for the request.  See the corresponding object definition for field details.

apiInstance.renewToken(clientId, body).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
clientId	String	Your application ID, available from the application dashboard.
body	RenewTokenRequest	An object containing the fields to POST for the request. See the corresponding object definition for field details.

Return type

RenewTokenResponse

Authorization

oauth2ClientSecret

HTTP request headers

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

revokeToken

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 Developer Dashboard.

Example

var SquareConnect = require('square-connect');
var defaultClient = SquareConnect.ApiClient.instance;

// Configure API key authorization: oauth2ClientSecret
var oauth2ClientSecret = defaultClient.authentications['oauth2ClientSecret'];
oauth2ClientSecret.apiKey = 'APPLICATION SECRET';
oauth2ClientSecret.apiKeyPrefix = 'Client';

var apiInstance = new SquareConnect.OAuthApi();

var body = SquareConnect.OAuthApi.constructFromObject({}); // RevokeTokenRequest | An object containing the fields to POST for the request.  See the corresponding object definition for field details.

apiInstance.revokeToken(body).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
body	RevokeTokenRequest	An object containing the fields to POST for the request. See the corresponding object definition for field details.

Return type

RevokeTokenResponse

Authorization

oauth2ClientSecret

HTTP request headers

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