OneTrust, LLC.
About the Developer Portal
Welcome to the OneTrust Developer Portal, your gateway to leveraging powerful APIs and SDKs for seamless integration and streamlined data flow with the OneTrust platform. Whether you are a developer, cybersecurity professional, data privacy officer, legal and compliance team member, digital marketing professional, or risk analyst, our portal is designed to cater to your unique needs.
Explore APIs designed to integrate effortlessly with OneTrust, discover the capabilities of our SDKs, and access a wealth of resources to help you get started. Kickstart your projects with validated "Recipes"—code samples tailored for common use cases. Stay updated with the latest enhancements in our Changelog. Our goal is to provide comprehensive documentation and resources that make self-service easy, allowing you to troubleshoot and build integrations independently.
Start Learning. Start Building. Start Launching!
Why They Stand Out
Best Onboarding Experience
The newly redesigned OneTrust Developer Portal homepage offers a comprehensive overview and directs users to key onboarding pages to ensure a seamless start for developers and partners. The API Overview and Quick Start pages provide a clear understanding of what our APIs offer and how they function, along with step-by-step guides to start integrating OneTrust APIs into your projects. Similarly, the SDK Overview and Quick Start page showcases the capabilities of our SDKs and includes detailed instructions for efficient usage.
For partners, the "Becoming a Technology Partner" section outlines the requirements for partnership, offers a quick sign-up process to receive a partner sandbox environment and facilitates the submission of integrations to the OneTrust Technology Alliances team. This ensures that partners can start collaborating with OneTrust with minimal hassle.
Developers can choose between the API or SDK tracks or search our Recipe repository for ready-to-use code samples that expedite development. Additionally, the new "Getting Started with the OneTrust APIs Hands-on Lab" enhances the onboarding experience by guiding users through the Developer Portal. This automated process includes spinning up the OneTrust application and emailing users their API Keys and Client Credentials within minutes, providing a development playground with detailed, perspective documentation. Users can then experience the power of OneTrust APIs firsthand with our "Try It" feature using the pre-populated credentials, which allows them to execute example calls directly from the Developer Portal, offering a practical introduction to API functionality.
If users ever get stuck at any point during the onboarding process, they can leverage the help widget for immediate assistance. This interactive feedback tool allows customers to rate their experience, provide comments, and access dynamically generated hyperlinks to relevant documentation and resources. The help widget includes a floating help button for easy access, feedback collection options, context-sensitive resource links, and personalized greetings. By providing real-time support and relevant information, the help widget ensures users can overcome any obstacles quickly.
With these enhancements, onboarding to the OneTrust Developer Portal is both straightforward and empowering.
Best Unified Enterprise Developer Portal
OneTrust enables organizations to achieve trust by design with a single platform, simplifying trust transformation across privacy, security, and ethics. Our platform provides everything needed to build trust, exactly when it is needed. OneTrust APIs are available within the API Reference section and are organized by the various Clouds within the Trust Management Platform, including the Trust Intelligence Platform, Privacy & Data Governance Cloud, GRC & Security Assurance Cloud, and ESG & Sustainability Cloud. Although these clouds offer different solutions to customers with distinct personas, they are all part of the same Trust Management Platform and are tightly integrated.
Our Developer Portal does not separate each cloud into various micro-sites; instead, it presents them side-by-side, enabling customers to access all documentation necessary to build tighter integrations. We maintain a consistent cloud theme throughout the entire developer portal, from the homepage to the Recipes, changelog, and API Reference page, where each API specification's title is preceded by the cloud it belongs to. This approach makes it easy for users to quickly identify and match their offerings with the appropriate APIs they should leverage.
By providing a unified platform that organizes and presents extensive API portfolios in a cohesive manner, the OneTrust Developer Portal exemplifies how an enterprise can create a streamlined, user-friendly interface that enhances both observability and integration capabilities.
Best Findability of Products
At OneTrust, our Developer Portal exemplifies this approach by integrating robust features and custom enhancements. While our vendor, ReadMe, offers many out-of-the-box features like global search, which can be filtered by content type, and the "jump to" feature for targeted API summary searches, our team has built additional custom enhancements based on community feedback to further improve usability and functionality.
Our portal features UI tags on each API's reference page that display essential information such as Release Status (e.g., Public Preview or Sunset Period) with a link to the corresponding changelog, API Specification with a downloadable link (swagger vs. OpenAPI), and whether the API is Highly Available with a link to architectural documents. This information is dynamically pulled from the API specs using an extension parameter: x-onetrust.
We also display the OAuth Scopes required for each API above the authorization box where users input their tokens, with a tooltip providing a description of each scope. This is dynamically extracted from the API specifications, ensuring developers have all the necessary information at their fingertips.
Our custom Help Widget further enhances the user experience by displaying dynamic, helpful resources based on the specific page or API spec being viewed. This widget is also generated dynamically via the API spec using the x-onetrust parameter, ensuring relevant support is always accessible. The widget also provides environment status in the top right corner of the widget with a hyperlink to the status page for more details; however, this is only displayed when there is an issue detected.
Additionally, we have developed numerous code samples, called Recipes, which are strategically placed throughout the documentation and API reference pages. These Recipes provide additional context on topics such as pagination and handling API Rate Limits, addressing common pain points identified by our audience.
The OneTrust Developer Portal features a well-structured landing page with entry points tailored to our main audiences, a comprehensive catalog, basic and faceted search capabilities, and suggestive discoverability. This organized and intuitive structure allows API consumers to easily find and utilize our APIs, enhancing their overall experience and enabling them to build and integrate more effectively.
