Better Integration with More REST - A Riffyn Nexus API Upgrade

Embriette Hyde

The Riffyn Nexus API has been a critical tool for Riffyn Nexus users to automate R&D labs by facilitating machine runs and data ingestion directly from instruments, as well as export of data for analysis. On a regular basis, 85% of our customers utilize the Riffyn API. With our latest Riffyn Nexus upgrade, we’ve updated the API to more closely adhere to REST architectural guidelines and to use the latest OpenAPI Specification. Because dozens of tools require that APIs follow these standards, this upgrade from API 1.0 to 2.0 makes it easier to use Riffyn Nexus in conjunction with those tools, expanding Riffyn Nexus’ integration capabilities.

“Riffyn Nexus API 2.0 brings impactful changes to our API. The increased adherence to REST and improved documentation allows developers and integrators faster, more-efficient routes to deploy tools that leverage Nexus inside their organization”

Riffyn Product Manager Jack Morel

The outcome — Better integration. More automation. Quicker to digitization. Our users get more rest too (pun intended).

So, how does Riffyn Nexus API 2.0 work?

Most of the changes to the Riffyn API are behind-the-scenes and won’t be noticed by users. Our users will pick up on some subtle changes that work together to provide a better user experience. There have been several key changes to the Riffyn API, including making all endpoints more aligned with REST standard, improving error reporting and handling, standardizing naming, query conventions, and schemas, updating and improving documentation, improving test coverage for more common user scenarios, and bundling API methods to map to the collection they’re modifying.

We’ll explore the endpoint update in a little more detail in this post.

Riffyn Blog Post Better integration and quicker to digitization with more REST a Riffyn Nexus API upgrade Image 1

In Riffyn API v1.0, there were multiple endpoints for the same REST resource, “comment.” In Riffyn API v2.0, those endpoints have been merged to reduce redundancy, to better adhere to REST standards, and to improve the user experience.

In Riffyn Nexus, users can make comments on their processes and on individual experiments. In API 1.0, these were treated as different endpoints, even though they are essentially the same thing. This led to redundancy in the system, and users had to access those comments differently to get, essentially, the same result. With API 2.0, that redundancy is eliminated by reducing the number of API endpoints from 14 to 5, making the API more RESTful and improving the user experience.

Current Riffyn Nexus users can access a suite of API 2.0 articles on the Riffyn Help Center to learn about the full range of updates and changes to the Riffyn API.

We strive to provide our customers with the best tools possible to streamline R&D processes. API 2.0 is one of the new features in Riffyn Nexus v4.2. The recently launched Riffyn Nexus v4.2 is packed with features to enable process developers to achieve faster process improvement. Other new v4.2 features include:


Follow our blog and social media on LinkedIn and Twitter to stay up to date with product news, company updates, and more. Sign up for our newsletter at riffyn.com.