Main content

Home

Menu

Loading wiki pages...

View
Wiki Version:
We now have the first reviewable version of that API. It is still in Beta, so routes are not stable. On the plus side, routes are not stable, so you have a chance to let me know what you think about the API, and we still have a chance to make those changes. **Note:** The formatting for all of the responses are changing. Look at [this github PR](https://github.com/CenterForOpenScience/osf.io/pull/3683) for details on the change. You can find the swagger docs for the API at <https://staging2-api.osf.io/v2/docs/>. The base route for the API is <https://staging2-api.osf.io/v2> and includes a Django Rest Framework view of the documentation. For an overview for the whole api, I recommend using the swagger docs. The DRF view is a little nicer for exploring using the links, so that's an option as well. Please let me know anything that doesn't work, anything that needs better documentation, or anything that you think is just wrong. We'll be adding more functionality in the coming weeks, but this subset of capability should handle our first expected use case, which is to allow scientists to integrate the OSF as a data storage service for their own processing scripts. Well, except for one this: we don't have OAUTH2 integrated yet. It's coming very soon, but you're not actually going to be able to use this in your own scripts until that happens. For now, the interactive documentation is what you need to use. If you want to try things that require user permissions, just log into the staging server at <https://staging2.osf.io/> and it will use your user credentials from there. You can verify if you're logged in by GETting <https://staging2.osf.io/api/v2/> and you'll see the user information for the currently logged in user. Also, bear in mind that this is pre-release software on a staging server, so expect the server to be down from time to time while we update software, and don't expect that anything you create on here to exist long-term.
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.