Introduction
Adyen is a financial technology platform, offering a range of services to help businesses succeed in the future of global commerce.
They do this by providing APIs and SDKs that enable their customers to accept payments, perform Know Your Customer verification, issue credit cards, accept charitable donations, and more.
Adyen’s DevPortal helps enable anyone integrating or using their platform, by providing them with clear instructions, step-by-step guides, and accurate and up-to-date reference information.
Why nominated?
Best API Reference Documentation
With over 100 endpoints, understanding Adyen’s APIs can easily be overwhelming.
With the API Explorer, Adyen has taken a novel approach to explaining their APIs. In addition to providing API reference, users can also run example API calls and receive a genuine response. This allows them to test out Adyen’s APIs and understand how they work.
To ensure up-to-date information, the API Explorer is automatically generated from OpenAPI specifications embedded in 100+ API endpoints. These are combined into a single portal.
The Adyen team have been working hard on improving this portal (which won a DevPortal award in 2019), and recently launched a beta of their new API Explorer (https://docs.adyen.com/api-explorer-beta).
This has been completely rebuilt, offering several UX and DX improvements, including:
- Improved layout and navigation.
- Responsive and mobile-friendly design.
- Filters for required and optional parameters.
- A dark mode.
Adyen plans to open source the web application for their new API Explorer, so that others in the API community can benefit from it too.
