The Adobe Developer Console (AKA Adobe I/O Console) is becoming the one-stop-shop for registering API keys and the Exchange App Manager will someday be integrated with the Adobe Developer Console to make it easy for your customers to provide you with the API access you need to make your integrations work. NOTE—the development of this feature has been temporarily put on hold. For now, you can probably skip the Endpoints tab when creating your App. This feature will be added at some future date but there's no firm date for us to share yet. But you can read on to see how it will work.
In the endpoints tab in App Manager you can provide a URL to that will (in the future) be used to give your system the necessary access to your clients' accounts and provide useful tools for troubleshooting the connection.
We are still building the functionality that will allow these features to work. So for now, you can add the URL to our system but it won’t get used quite yet. We’ll send out an email when these features are ready and you’ll begin to see traffic to it then. Below I’ll describe the various methods that will be sent to the endpoint and why you might want to add them to your integration. Check out the Swagger API documentation for more information on the data format and variables.
API Method for new integrations
If you have an integration that use APIs that authenticate through Adobe I/O, App Manager will soon make the authentication process much simpler for your customers. When you create your integration you will tell App Manager what API access you need. When a customer adds your integration, a pop-up will inform them what API access you need and why. Then they will be given the option to grant access or refuse. If they grant access, App Manager will create a user with the correct permissions and generate the public/private keys and authorization credentials for this user. It will then pass these credentials to you via the partnerintegration (POST) API Method and you can use them to generate an access token to access the customer's Adobe Analytics instance via the APIs.
This method will be used to test the status of your system. You will be able to call Adobe Exchange’s Keep Alive API at a pre-defined interval (the API is still being built and the endpoint is TBD). Once Exchange receives this call, Adobe Exchange will call your endpoint to complete the Handshake and get an update on the current connection.
Delete Partner Integration Method
This is the method for terminating the existing connection. This method will be invoked when a customer decides to uninstall your integration.
Partner Integration PUT Method
This is the method for modifying the permissions that have been granted to you. Customers will be able to add or remove services or permissions that were previously provided at the installation time and this method will be invoked to send you the new token with the new permissions. To check on what permissions the customer has granted you, you can use the Adobe I/O metascopes API.
Test Connection Method
This method will be similar to the callback method, but instead of the test being initiated on your side on a regular basis, the connection test will be initiated by customers. This will be used by customers to test that your system is up and running when they suspect there might be a problem with the integration. The Test connection method will be invoked from “My Exchange” section when the customer logs in to Exchange to see the status of the apps.