Adobe Experience Cloud Assurance Tools Public APIs 1.0
NOTE: On January 1, 2025, Adobe will be transitioning to OAuth2.0 server-to-server credentials instead of JWT. More information can be found here.
For those of you who are already familiar with Adobe Experience Cloud Assurance Tools, we are hopeful you have made gains in your productivity, efficiency, and reliability while getting your solution to market. In the spirit of making you even more productive and successful, we are pleased to announce we have further enhanced Assurance Tools with the addition of Assurance Tools Public APIs.
Let’s face it, development is difficult. Especially mobile development. Working in mobile platforms and combining a many-headed monster of SDKs can be time-consuming, hard to debug, and difficult to test. While struggling through network traces, debug logs, and console logs to figure out what’s wrong (something always is!), the pressure to deliver only increases.
Luckily, with Adobe Experience Cloud Assurance Tools, mobile development is accelerated, and those gnarly bugs and blocking issues become self-evident. Combining the intelligence of the Assurance Tools extension for Adobe Experience Platform Mobile SDK with your application, and Assurance’s robust backend server tools, you will find yourself ahead of schedule and enjoying mobile and web development once again.
With new enhancements this year, developers are no longer required to manually log in to the Adobe Assurance UI to create a live debugging session. By employing the addition of Assurance 1.0 Public APIs, developers can now manage sessions and read events and annotations, and only return to the UI as desired.
Access to Assurance Tools 1.0 APIs is managed through the use of JSON Web Tokens (JWT), generated within the Adobe Developer Console.
Here is the workflow for getting started:
API Explanation:
- createSession: creates a new Assurance Tools session to which a client will ultimately connect.
- updateSession: updates session information, like session name or link.
- sessions (and read annotations): retrieves sessions for a user’s organization, along with annotated information.
- deleteSession: deletes a session within a user’s organization.
- events (and read annotations): reads event data, and annotations, within a given user’s session.
API Examples:
Create a Session (Mutation)
curl 'https://graffias.adobe.io/graffias/graphql' \
-H 'Content-Type: application/json' \
-H 'x-gw-ims-org-id: [Organization ID]@Adobe.Org' \
-H 'x-api-key: [Client ID]' \
-H 'Authorization: Bearer [Access Token]' \
--data-binary '{"query":"mutation createSession($session: SessionInput!) { createSession(session: $session) { orgId uuid name link token }}","variables":{"session":{"name":"test-mutation","link":"testUrl://default"}}}'Read Sessions (Query)
curl 'https://graffias.adobe.io/graffias/graphql' \
-H 'Content-Type: application/json' \
-H 'x-gw-ims-org-id: [Organization ID]@Adobe.Org' \
-H 'x-api-key: [Client ID]' \
-H 'Authorization: Bearer [Access Token]' \
--data-binary '{"query":"query { sessions { uuid name }}"}'The fuller example sets for the APIs can be found here.
Not only will Assurance Tools public APIs accelerate your ability to debug issues within your solution, but these same APIs can also be used to script an end-to-end test for even further validation.
Here is one possible solution, as represented in Node-RED, using Assurance Tools public APIs and a mobile automation framework for on-device/on-simulator testing.
As you can see, by integrating with Adobe Assurance APIs, along with APIs supported by device emulator providers, an entire E2E test flow can be covered from JWT Token generation, generating a new Assurance session, launching a mobile test flow, having the test events flow into the session, and finally, validation using Adobe Assurance plugins.
For any assistance or guidance in the construction of such a flow yourself, or with any general questions for the Adobe Assurance team, please reach request access to: https://projectgriffon.slack.com/
Or post questions to: https://experienceleaguecommunities.adobe.com/t5/adobe-i-o-console/ct-p/adobe-io-console
We hope you make Adobe Assurance and its public APIs a common part of your toolset during mobile and web development and share your success stories with your fellow developers.
Happy coding!
Helpful Links:
