AppCloud installation flow
When a Customer Admin installs an app, Eloqua calls out to the configured enable URL with a POST request. The call will resemble the following:
https://example.com/awesomeapp/api/enable?enableurl&oauth_consumerkey=XXX-XXX-XXX-XXX-XXX
&oauth_nonce=nonce&oauth_signature_method=SIG-METH&oauth_timestamp=111111111
&oauth_version=1.0&oauth_signature=signature&callback=https%3A%2F%2Fsecure.eloqua.com%2FApps%2FCloud%2FAdmin%2FInstall%2FCallback%2Fa1b2c3d4%3Fguid%3Dz9y8x7w6
The app must respond in one of two ways: if the app does not require configuring by the user, it can return an HTTP 200 OK response. Otherwise, it should respond with an HTTP 302 redirect to another page. The following sections detail each option.
No additional information needed
In this scenario, there is no need to obtain OAuth authorization for the installing user's instance, nor any other configuration information. The appropriate response is then:
HTTP/1.1 200 OK
The app install status will be set to the "Ready" and marketers will be able to use it.
Additional information needed
If you need to have the user configure the application or provide OAuth authorization for their instance, you should respond with an HTTP 302 redirect to another page. When the app is configured, you need to call back in to the callback URL.
- Respond with a redirect:
HTTP/1.1 302 Redirect
If your app needed to go through the OAuth flow, the redirect might point to
login.eloqua.com/auth/oauth2/authorize, Eloqua’s OAuth endpoint. - Call in to the callback URL when the user has finished configuring the application. Using the above example, the call would look like:
https://secure.eloqua.com/Apps/Cloud/Admin/Install/Callback/a1b2c3d4?guid=z9y8x7w6
Eloqua provides the callback URL when you request it as a template in your templated enable URL. Calling the callback URL tells Eloqua that the install status should be set to "Ready" so that marketers can start using the application.
- When the app provider calls back in to complete the installation, it can optionally append a redirect URL:
https://secure.eloqua.com/Apps/Cloud/Admin/Install/Callback/{installId}?guid={guid}&redirect={redirectUrl}Replace parameters in {} with desired values, and the redirect URL must be in HTTP or HTTPS. The redirect URL supports templated URL parameters. You must URL encode the redirect URL to ensure that template parameters are returned back to you. If no redirect URL is given, or if the redirect URL given is not acceptable, then the user is redirected to Eloqua’s catalog.