You can provide a URL endpoint to App Manager that will (in the future) be used to send API calls to your system to give your integration added functionality and robust error-checking. This endpoint is optional but we recommend adding it if you can and building the infrastructure on your side to handle the API calls.
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.
Authentication API Method
The Adobe I/O Console is becoming the one-stop-shop for registering API keys. 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. Soon you will be able to 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 take care of creating a user with the correct permissions and the JWT authorization token for this user. It will then pass this token to you. This Authentication API URL is the endpoint that App Manager will pass the token to. If you are planning on using an API that authenticates via Adobe I/O, you will need to provide an endpoint for App Manager to send those tokens to. If not, you can leave this field blank.
This method will be used to test the status of your system. Soon, 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 this Callback method endpoint to complete the Handshake and get an update on the current connection.
This is the method for terminating the existing connection. This method will be invoked when a customer decides to uninstall the app.
Modify Connection 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 JWT token with the new permissions.
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.