ApexERPHost

<back to all web services

Authenticate

The following routes are available for this service:
All Verbs/auth
All Verbs/auth/{provider}
All Verbs/authenticate
All Verbs/authenticate/{provider}
Authenticate Parameters:
NameParameterData TypeRequiredDescription
providerpathstringNo
StatequerystringNo
oauth_tokenquerystringNo
oauth_verifierquerystringNo
UserNamequerystringNo
PasswordquerystringNo
RememberMequerybool?No
ContinuequerystringNo
noncequerystringNo
uriquerystringNo
responsequerystringNo
qopquerystringNo
ncquerystringNo
cnoncequerystringNo
UseTokenCookiequerybool?No
AccessTokenquerystringNo
AccessTokenSecretquerystringNo
MetaqueryDictionary<string, string>No
AuthenticateResponse Parameters:
NameParameterData TypeRequiredDescription
UserIdformstringNo
SessionIdformstringNo
UserNameformstringNo
DisplayNameformstringNo
ReferrerUrlformstringNo
BearerTokenformstringNo
RefreshTokenformstringNo
ResponseStatusformResponseStatusNo
MetaformDictionary<string, string>No

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

HTTP + X-PROTOBUF

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

POST /auth HTTP/1.1 
Host: apex.nikoratrade.ge 
Accept: application/x-protobuf
Content-Type: application/x-protobuf
Content-Length: length

{"provider":"String","State":"String","oauth_token":"String","oauth_verifier":"String","UserName":"String","Password":"String","RememberMe":false,"Continue":"String","nonce":"String","uri":"String","response":"String","qop":"String","nc":"String","cnonce":"String","UseTokenCookie":false,"AccessToken":"String","AccessTokenSecret":"String","Meta":{"String":"String"}}
HTTP/1.1 200 OK
Content-Type: application/x-protobuf
Content-Length: length

{"UserId":"String","SessionId":"String","UserName":"String","DisplayName":"String","ReferrerUrl":"String","BearerToken":"String","RefreshToken":"String","ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"Meta":{"String":"String"}}