getLoginUrl

This method gets the URL for the constituent API and returns an authorization token that can be used as the value of the "auth" parameter in most other API calls. 


Client ServletServer ServletHTTP Methods SupportedRequires Authentication
CRConsAPI None. GET, POST No.

Client API Syntax

https://secure2.convio.net/organization/site/CRConsAPI?method=getLoginUrl

Usage Notes

This method ensures proper authentication in cross-domain requests. It can be used to get a token when a call is made without a constituent ID or member ID.  The returned token is not an sso_auth_token, but can be used as the value of an "auth' parameter in some other API calls.

Any time the auth token is used, JSESSIONID must be passed as POST data. JSESSIONID must also be passed as POST data in some other cases such as with TeamRaiser API methods that don't require an auth token, but instead rely on the JSESSIONID to identify the logged in user, like getRegisteredTeamraisers. Since the JSESSION ID must be included as POST data, this means that GET should not be used, even when an API method says that it supports GET requrests. The routing_id is used to ensure that a request is routed to the correct JVM. It is to be included after the API servlet, separated by a semi-colon.

Client API Parameters

Common Server Parameters

See topic Common Parameters.

Response

See topic HTTP Status Codes.

XML response


        
JSON response
{"getLoginUrlResponse":{"JSESSIONID":"2222222222222222222222.app337b","routing_id":"00000000.appb","url":"https://secure3.convio.net/organization/site/CRConsAPI;jsessionid=00000000.appb?NONCE_TOKEN=888888888888888888888888888888","token":"3XSekmjfoaeirjeoaifajealEOWEKDFHXrqO_McjDaJ51FbRvz1x1virbty_luMqc"}}

Leave a Comment

Nickname
Comment
Enter this word: