YM REST Services

<back to all web services

GetAccessToken

The following routes are available for this service:
POST/OAuth/GetAccessTokenReturns the access_token in exchange of AppId, AppSecret, Code/RefreshToken. Note: the key “AppSecert” has been deprecated and will be removed in a future update.
GetAccessToken Parameters:
NameParameterData TypeRequiredDescription
GrantTypebodyGrantTypeNo

Allowable Values

  • Code
  • RefreshToken
AppIdbodystringNo
AppSecertbodystringNoThis key has been deprecated and will be removed in a future update. Please use the “AppSecret” key.
ScopebodystringNo
CodebodystringNo
RefreshTokenbodystringNo
AppSecretbodystringNoThis key replaces the “AppSecert” key.
BaseDto Parameters:
NameParameterData TypeRequiredDescription
UsingRedisformboolNo
AppInitTimeformDateTimeNo
ServerIDformstringNo
BaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
ClientIDformintNo
ResponseStatusformResponseStatusNo
BypassCacheformboolNo
DateCachedformDateTimeNo
DeviceformDeviceNo
GetAccessTokenResponse Parameters:
NameParameterData TypeRequiredDescription
AccessTokenformstringNo
ExpiresOnUtcformDateTimeNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /OAuth/GetAccessToken HTTP/1.1 
Host: ws.yourmembership.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	GrantType: Code,
	AppId: String,
	AppSecert: String,
	Scope: String,
	Code: String,
	RefreshToken: String,
	AppSecret: String,
	UsingRedis: True,
	AppInitTime: 2024-05-03T09:18:43.6873489-04:00,
	ServerID: WS-5-155-994,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	},
	BypassCache: False,
	DateCached: 2024-05-03T09:59:22.9751527-04:00,
	Device: Desktop
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	AccessToken: String,
	ExpiresOnUtc: 0001-01-01,
	GrantType: Code,
	AppId: String,
	AppSecert: String,
	Scope: String,
	Code: String,
	RefreshToken: String,
	AppSecret: String,
	UsingRedis: True,
	AppInitTime: 2024-05-03T09:18:43.6873489-04:00,
	ServerID: WS-5-155-994,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	},
	BypassCache: False,
	DateCached: 2024-05-03T09:59:22.9907557-04:00,
	Device: Desktop
}