The OSH-Park API allows you to interact with our system programatically from your own application. Using the API you interact with Resources such as:
- Uploads
- Projects
- Orders
The API attempts to confirm to the RESTful design principals. You interact with the resource exposed via the API by accessing resource collection and element URIs using the HTTP verbs (GET, POST, PUT and DELETE). The API only accepts and responds with JSON.
Authentication
Authentication is implemented using a short-lived session token generated by the API. For information can be found in API Session Tokens.
Resources
The available resources are listed on the API Resources page.
Response Data
The response data is always a JSON object. You should either send the correct JSON HTTP Accept
and Content-Type
headers or add a .json
file extension to the resource you are accessing.