All Categories ​ > ​ ​Inventory ​ > ​     Inventory API Introduction 🧪

Inventory API Introduction 🧪

Updated 4 months ago by Vaida

Inventory Beta is available to all existing and new Enterprise customers, and will be available to Community users in the near future. Learn more at the RSpace Inventory Hub.
The Inventory API is currently under active development and not yet guaranteed to be stable. We will work on documenting the stability of the API following the Beta in September 2021.

Inventory is being developed with an API-first approach. As a result, all of the actions that can be performed through the user interface can also be performed through the API.

After the Beta release in September 2021, we intend to provide worked examples and code snippets in Bash and Python in our Github repo. Any suggestions or contributions are always welcome via pull requests; you can also emails us to request specific API use cases to be documented.

API Key Authentication and Swagger Documentation

The steps for obtaining your API key, authenticating, and accessing the documentation are similar to the ELN steps described in RSpace API Introduction. Please note you will have to generate an API key on the Inventory-enabled RSpace instance at https://rs-inventory-beta.researchspace.com, and the Swagger documentation is available at https://rs-inventory-beta.researchspace.com/public/apiDocs.

To switch between RSpace ELN and Inventory APIs on Swagger, use the "Select a definition" dropdown:

How did we do?

Powered by HelpDocs (opens in a new tab)

Powered by HelpDocs (opens in a new tab)