API Catalog
EY Fabric API Platform provides a central authoritative API Catalog for all APIs across EY. The Catalog is integrated with EY Fabric Apigee Platform.
Users
Both API Producer's and Consumers.
User flows
Sample API Cards
It layouts the overall API summary which will be used to further drill down to the API details page.
API Catalog landing page
API Detail Page
This is a product detail page, where we have the technical, operational, and Maturity of the API among other details, segregated into sections. And last but not least, to consume the API in different environments.
Other Samples of the product detail page with sidebar metrics, Without a hero banner.
Feedback
Cumulative information on the user's ratings and reviews about the product's usefulness and features.
Provide feedback window
Multiple states are visualized in the design: the default states are all the gray ones, the hover states are white with additional information and the yellows are the selected or active selection for the question.
API maturity scores
This section helps the users to understand how the API works in a real-world scenario. It quantifies the operational parameters and the producer's assessment for a high-quality build.
It encourages consumers to take a data-driven decision on their consumption journey i.e to leverage the product to the extent it is made.
Resources
All the terms and the know-how of the API product at one place.
Subscribe
This is where and how the consumption of the API happens. Users will have the prepopulated list of all the apps that they or their team owns, they can choose the apps with respect to the environment in which they need to Subscribe to this API product.
Producers canvas
Manage APIs
User: API Producer
Manage view lists all the APIs and API products that the producers own and manage the lifecycle and performs the CRUD operations.
Adding an API Product
Producers have to fill in an extensive form, very much technical, in order to create an API.
Complex problem to solve :
Reduce User's cognitive load
Increase User fill-rates
Improve the tracking of the progress made while creating
Provide more system-generated assistance to the user
Provide internal/external support to a time constrain business users
Configure the API product for different environments.
Manage subscription requests
Producers can able to auto or manually approve and reject the subscription requested by the consumers for their API products. They also reserve the right to cancel an active subscription for their consumers.
Blank and error states
Challenges
Consistency in voice, tone, and brand guidelines within each product, and across each service line
Getting clearly defined statements of work from clients/Stakeholders
Addressing content challenges with clear solutions
Understanding the needs of the user
Understanding how the user engages with the content and how they interpret the information