|
|
REST APIAccess TokenCalled by publisher to exchange the request token for access token. This API can be called only after a request token is authorized. The publisher calls this URL in response to the Adobe Wave Desktop Client calling the callback URL provided by the publisher. URI/identity/1.0/oauth/accesstoken HTTP methods supportedPOST, GET Request query parameters
Example requesthttps://id-wave.adobe.com/identity/1.0/oauth/accesstoken?oauth_consumer_key=publisheraccnt@funwithothers.com&oauth_token=47a6244f7e304a96a95f4d51f46b528b&oauth_signature_method=PLAINTEXT&oauth_signature=password123%264e9dc7503a8a416fa1606441caacf15a&oauth_timestamp=1226366624&oauth_nonce=foobar Response parametersA successful response
has a MIME type of application/x-www-form-urlencoded and contains
the following parameters:
The publisher makes a persistent mapping between the returned access token and the associated subscriber’s identity on the publisher’s site. When the publisher wants to make a point-to-point notification to a specific subscriber, they must look up the subscriber’s associated access token. Example responseoauth_token=e0FFUzoxMjg6Q0JDOlBLQ1M1UGFkZGluZ317R3NYS1BVdWJ3aGlINmlQY1IxGTArdz09fWeiMgPYVw%2FBagXTXwwoQrPtMKe3W%2F9qwiRHVgqQhtK0hGZd6p6TtI8GLnJNtfBxE99hROe%2FDwr0Da83t1QLRHI%3D&oauth_token_secret=da9231bcdeb24814b023ce0167d12f5 Response codes
API TokenAuthenticates the user against the Adobe user database and returns an ID token, if successful. URI/identity/1.0/auth/apitoken.xml HTTP methods supportedPOST Request query parameters
Request header parameters
Example requesthttps://id-wave.adobe.com/identity/1.0/auth/apitoken.xml?username=publisheraccnt@funwithothers.com&password=password123 Example responseThe parameter is passed in the HTTP POST body. The content type of the HTTP body is MIME type application/xml. The token is returned as XML. There is an outer element called apitokenResponse whose namespace is urn:com:adobe:identity:1.0. Inside this element is a single element named apitoken with the same namespace. <?xml version="1.0" encoding="UTF-8"?> <apitokenResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="urn:com:adobe:service:identity:1.0"> <apitoken>e0FFUzoxMjg6Q0JDOlBLQ1M1UGFkZGluZ317KzVaNm52UG0xUG5GNk4vTEpkbithZz09fWRkjFr5OIV4QZ1qUbKca5zShMtC8yK7/qAkVhM5fNkixY0FZKjlJRHoBfbTNJfsnfocCO3CEefEBpiDbb/NTCE= </apitoken> </apitokenResponse> Response codes
NotificationSends a notification to a topic. You can send a request to the notification API in application/x-www-form-urlencoded format or in multipart/form-data format. You can optionally send a link, an access token (for point-to-point feeds), and a thumbnail image. To send notifications to individual subscribers the feed that contains the topics must be configured as point-to-point. To send point-to-point notifications, send an access token. Thumbnail images cannot be larger than 40x40 pixels and must be JPG or PNG files. Adobe Wave converts the image to PNG format before sending it to a client. You can send a thumbnail image in one of the following ways:
URI/notificationgateway/1.0/notification HTTP methods supportedPOST Request query parametersUse the following query parameters to send a request in application/x-www-form-urlencoded format:
Use the following query parameters to send a request in multipart/form-data format:
Example requestThe following example request is in application/x-www-form-urlencoded format: https://p000-wave.adobe.com/notificationgateway/1.0/notification?X-apitoken=e0FFUzoxMjg6Q0JDOlBLQ1M1UGFkZGluZ317UmNvVVg2alhPOTlQV0pTOHNUaVhRQT09fSmTNJOx08q1xYGZ3TZwGWgQpjAu0If5zv93XIGUTER5CPN3SezHO6xIKBFrHHq3CU38XUZX6ZyBzDSxvHddUUd0uPoBcadXwJGiXakjrKw2&topic=company_3480%2Ffeed_184836%2FCAAE63B2-32FA-00F4-1748-CA1076A5547A&message=Test%20message%202485&link=http%3A%2F%2Fwww.adobe.com&accesstoken=e0FFUzoxMjg6Q0JDOlBLQ1M1UGFkZGluZ317V1RiajMwNjN6K1Urb05IbExCMHNXQT09fYnvOwt1%2Fi5WDm5h1xQl6l9hmAwqErtDvizk0rG0i9B2NV93IYxgeTVYY7vdmAN6h%2FRQmEaP5qr%2F%2F%2FbhWMjZJ7PX5w5vtSvsYtq9306ZDnLIX7kIPz424HuNOivXKltV4q6Pnai6nuREo%2FRZc3cCeCc%3D The following example request is in multipart/form-data format: POST /notificationgateway/1.0/notification HTTP/1.1 Content-Type: multipart/form-data; boundary= -----------------------------6578211237537995051102246882 Host: localhost Content-Length: 4014 -----------------------------6578211237537995051102246882 Content-Disposition: form-data; name="X-apitoken" e0FFUzoxMjg6Q0JDOlBLQ1M1UGFkZGluZ317c0F5RzBSV0dSTEpxNnBHdXlFTk5CUT09fYxhhPU7Z8lPkOtXX28tSxWO7EEkrxtaCPw3h0oP7w40JrVa652dV3WEPi3I7sguubxqY/YwinjOz6o0Rzf/Yb5Fj3VahacHEhIL0wZLRWde -----------------------------6578211237537995051102246882 Content-Disposition: form-data; name="topic" company_3480/feed_184836/CAAE63B2-32FA-00F4-1748-CA1076A5547A -----------------------------6578211237537995051102246882 Content-Disposition: form-data; name="message" Test message 2512 -----------------------------6578211237537995051102246882 Content-Disposition: form-data; name="accesstoken" e0FFUzoxMjg6Q0JDOlBLQ1M1UGFkZGluZ317bXUvYXA4Zk94MU1CeHEvUTdhZFg2Zz09fWnYyT8E2m2ESJ/gFuJYPB3UNbH2I1Wv6BLcegf/5KexK27uxocI2gTmSoKwiBJIZwXquHduUVSUARDKmdglBqsGJsgMasUuOVgW4bq1/7EJStnFvby8irE/7249I76NqXW1EDekjjgR4uodF5L9l9U= -----------------------------6578211237537995051102246882 Content-Disposition: form-data; name="imagetype" image/png -----------------------------6578211237537995051102246882-- Example responseThe following response indicates success: HTTP/1.1 204 No Content Response codes
Request TokenCalled by a publisher to obtain a request token, which is exchanged later for an access token. Called in response to the Adobe Wave Desktop Client calling the initiation URL provided by the publisher. URI/identity/1.0/oauth/requesttoken HTTP methods supportedPOST, GET Request query parameters
Example requesthttps://id-wave.adobe.com/identity/1.0/oauth/requesttoken?oauth_consumer_key=publisheraccnt@funwithothers.com&oauth_signature_method=PLAINTEXT&oauth_signature=password123&oauth_timestamp=1226366624&oauth_nonce=Axzyse72n Response parametersA successful response
has a MIME type of application/x-www-form-urlencoded and contains
the following parameters:
The publisher must do two things with
this data:
Example responseoauth_token=47a6244f7e304a96a95f4d51f46b528b&oauth_token_secret=4e9dc7503a8a416fa1606441caacf15a Response codes
Initiation APIThe publisher implements the Initiation API. The publisher specifies the URL for this API in the feed details in the Publisher Portal. For point-to-point notifications, Adobe Wave Desktop Client calls the URL to link the publisher to the user’s Adobe Wave account. The call to the Initiation API tells the publisher to start a new account linking transaction. The publisher then calls the Request Token API to obtain a request token. The request token is returned to the Adobe Wave Desktop Client. URIChosen by the Publisher. Must start with http or https. HTTP methods supportedGET Request query parametersNone. Request header parametersNone. Response parametersThe response must have the content type application/x-www-form-urlencoded. The only response parameter is called oauth_token. Make sure that the HTTP body contains only this value. Do not following the token with white spaces or newline characters. Example requestGET /auth/initiation.php HTTP/1.1 Host: www.funwithothers.com Example responseHTTP/1.x 200 OK Content-Type: application/x-www-form-urlencoded oauth_token=541bf00d0a5146cf90eb4a7a3ac6a030 Response codes
Callback APIThe publisher implements the Callback API. The publisher specifies the URL for this API in the feed details section of the Publisher Portal for point-to-point feeds only. The Adobe Wave Desktop Client calls the URL when a user has successfully authorized the OAuth request token. The Callback call signals to the publisher that the request token can be exchanged for an access token. The publisher then calls the Access Token API. In the Callback API response, the publisher tells the user whether the account linking transaction succeeded or failed. Unlike the Initiation API, the response of the Callback API is not sent to Adobe Wave Desktop Client. Instead, Adobe Wave Desktop Client opens a browser window and the response is rendered in the browser. XHTML is the preferred response content type. Because the browser facilitates all interactions with the publisher's service, the publisher must determine whether the user is logged in to the publisher's website. When the user is identified and authenticated, the publisher can associate the access token with a user account. About the invokeArgs parameterThe subscription badge supports a parameter named invokeArgs, for use only with point-to-point notifications. Use this parameter to attach context data from your website to OAuth protocol interactions. When a user clicks your customized badge, the badge forwards your invokeArgs data to the Adobe Wave Desktop Client. After the user authorizes the request token, the Adobe Wave Desktop Client returns the invokeArgs data attached to the callback URL. The invokeArgs data usually identifies the session that started the OAuth token exchange process. Session information is useful after you exchange the request token for an access token because you must store the access token with the context of the session that requested it. Matching the correct session to the access token can be difficult if multiple requests occur simultaneously. To avoid this problem, publishers can use invokeArgs parameters to identify the originating user or session. The callback URL mechanism allows additional parameters to be attached to the end of the query. These parameters include your invokeArgs data. In Adobe Wave, the callback URL is constructed according to the OAuth specification, section 6.2.3. To send a custom invokeArgs value, set the invokeArgs global JavaScript variable in the badge.html file. Callback URL formatCallback URLs are constructed as follows: <callback_url_base><concatenator>oauth_token=<request_token> <callback_url_base> includes three concatenated subcomponents: <fixed_callback_base_url><concatenator><feed_info>[<concatenator><invoke_args>] Use standard HTTP query format to concatenate strings. Use a question mark (“?”) to separate the base URL from the first parameter. Use an ampersand (“&”) for all subsequent parameters. Callback URL parameters
Example requesthttp://www.funwithothers.com/auth/callback.php?feedId=feed_574753&companyId=company_779050&sessId=123412876443&oauth_token=c8cd3e0d1c4640de8740215c49372c00 
|
