Main content

Home

Menu

Loading wiki pages...

View
Wiki Version:
**OSF API Bootcamp** Welcome to the OSF API! OSF maintains a free and open API, an Application Programming Interface, that can be used to extend OSF capabilities into other custom software development projects. APIs enable different systems to “talk” to one another, exchanging information that would be otherwise inaccessible. APIs are an ideal way to facilitate [FAIR data][1], and is a key component of the OSF product vision of interoperability and meeting research communities “where they are”. In some cases, the API can reveal information or connections that are not available in the OSF UI. This may be helpful when providing user support or making community/member recommendations. The OSF API is well documented [here][2]. The documentation provides some endpoints that will work directly in the browser and require limited intervention to use. Others do require an additional resource. The bootcamp is going to provide the tools to use the OSF API for personal, manual inputs. Systematic use requires more resources and development experience, but the basic components work the same way at a larger, faster scale. The bootcamp will utilize a simple web browser for the most basic queries. Others will require a very simple tool to enable most API features: the [Google OAuth 2.0 Playground][3]. The OAuth 2.0 Playground is a tool for developers that simplifies experimentation with the OAuth 2.0 protocol and APIs. Trying out some requests in the OAuth 2.0 playground can help you understand how the protocol functions, and you can implement the queries in other tools as you become more comfortable or if your needs change. [1]: https://www.go-fair.org/fair-principles/ [2]: https://developer.osf.io/ [3]: https://developers.google.com/oauthplayground/
OSF does not support the use of Internet Explorer. For optimal performance, please switch to another browser.
Accept
This website relies on cookies to help provide a better user experience. By clicking Accept or continuing to use the site, you agree. For more information, see our Privacy Policy and information on cookie use.
Accept
×

Start managing your projects on the OSF today.

Free and easy to use, the Open Science Framework supports the entire research lifecycle: planning, execution, reporting, archiving, and discovery.