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 .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
Content-Type: application/json
Content-Length: length

{"GrantType":"Code","AppId":"String","AppSecert":"String","Scope":"String","Code":"String","RefreshToken":"String","AppSecret":"String","UsingRedis":true,"AppInitTime":"2024-09-07T22:22:20.2611970-04:00","ServerID":"WS-4-137-943","ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"BypassCache":false,"DateCached":"2024-09-07T23:05:50.6676836-04:00","Device":"Desktop"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"AccessToken":"String","ExpiresOnUtc":"0001-01-01T00:00:00.0000000","GrantType":"Code","AppId":"String","AppSecert":"String","Scope":"String","Code":"String","RefreshToken":"String","AppSecret":"String","UsingRedis":true,"AppInitTime":"2024-09-07T22:22:20.2611970-04:00","ServerID":"WS-4-137-943","ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"BypassCache":false,"DateCached":"2024-09-07T23:05:50.6686819-04:00","Device":"Desktop"}