addressBookImportOAuthCallback

Handles the callback from an Open Authentication provider and fetches the user's address book

Client Servlet Server Servlet HTTP Methods Supported Requires Authentication
CRAddressBookAPI None. GET, POST No.

Client API Syntax

https://secure2.convio.net/organization/site/CRAddressBookAPI?method=addressBookImportOAuthCallback &api_key=value &v=value [ &center_id=value ] [ &error_redirect=value ] [ &redirect=value ] [ &response_format=xml | json ] [ &sign_redirects=value ] [ &source=value ] [ &sub_source=value ] [ &success_redirect=value ] [ &suppress_response_codes=value ] &code=value &import_job_id=value &oauth_token=value &oauth_verifier=value

Usage Notes

Prior to calling this method, you must successfully call startOnlineAddressBookImport and redirect the user to the authentication URL returned by the host provider.

This method passes the returned OAuth credentials to the hosting provider along with a request to begin the download job. After the user authenticates with the hosting provider and gives consent for your app to access his address book, the hosting provider redirects to the URL in the callback_url parameter of startOnlineAddressBookImport. The callback_url may specify this method directly, or may specify a page on your web server containing script that calls this method (for an example, see the callback handler page in TeamRaiser Participant Center, /pc2/address_book_import_oauth_callback_handler.html).

Note: By default, your site is configured to use system default OAuth credentials when requesting addresses from Google or Yahoo. As a result, users will be notified that "Luminate Online" is requesting permission to access their address book. If you want your organization's name to appear instead, you must obtain your own OAuth credentials and configure your site to use them.

Client API Parameters

Common Client Parameters

See topic Common Parameters.

code

Required. OAuth 2 code

Type xsd:token.

import_job_id

Required. ID of an address book import job.

Type xsd:integer.

oauth_token

Required. Open Authentication token.

Type xsd:token.

oauth_verifier

Required. Open Authentication verifier.

Type xsd:token.

Response

See topic HTTP Status Codes.

XML response
<?xml version="1.0" encoding="UTF-8"?>
<addressBookImportOAuthCallbackResponse xsi:schemaLocation="http://convio.com/crm/v1.0 http://service.convio.net/xmlschema/crm.public.v1.xsd" xmlns="http://convio.com/crm/v1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">OK</addressBookImportOAuthCallbackResponse>

        
JSON response
{"addressBookImportOAuthCallbackResponse":{"content":"OK"}}

        

Leave a Comment

Nickname
Comment
Enter this word: