{"_id":"56e3719c591f620e00bf509b","isReference":false,"slug":"getting-started","type":"basic","user":"56e371538b32a10e00f79750","__v":6,"api":{"params":[],"results":{"codes":[]},"settings":"","url":"","auth":"required"},"githubsync":"","version":"56e3719a591f620e00bf5098","createdAt":"2016-03-12T01:32:12.211Z","updates":[],"excerpt":"This page will help you get started with Orbirental. You'll be up and running in a jiffy!","link_external":false,"order":0,"title":"Getting Started with the Orbirental API","parentDoc":null,"project":"56e3719a591f620e00bf5095","sync_unique":"","body":"[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/fKAZpGIsTEePni9MFSWA_Orbirental_GGB_3.png\",\n        \"Orbirental_GGB_3.png\",\n        \"1000\",\n        \"653\",\n        \"#774518\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]\n## Welcome to the **Orbirental API**!\n\nThis API is still under development, but we're working hard to improve it! Please [contact us](https://www.orbirental.com) if you run into trouble.\n\nIf you notice the docs are out of date or are unclear, please don't be shy about clicking the \"Suggest Edits\" link! We're working to keep these docs up to date, however sometimes we get behind – and we'd love your help.\n\n\n## Prerequisites\n\nAccess to the Orbirental API is granted to users with **Gold** or **Growth** accounts, or to organisations being part of the **Orbirental prefered partners**. If you need to upgrade your account to Gold level, you can do so from the page *Agency Settings > Account Upgrade*. If you want to apply to be a prefered partner, you can do so by sending an email to partner:::at:::orbirental.com.\n\n\n## Authentication\n\nAuthentication requires an API key, which can be acquired from your Agency Settings page. You will need to include your key in every request made to the API. The API key has have to be provided as an HTTP request header called  *X-ORBIRENTAL-APIKEY*.\n\n\n## Sandbox vs Production\n\nAPI development will always have to start on our sandbox. Once you feel that you got things under control, just send us a note and we'll enable your access to production.\n\n\n## Support and Feedback\n\nPlease feel free to send us suggestions or issues either through our Intercom channel or at support@orbirental.com.","category":"56e3719b591f620e00bf5099","hidden":false,"link_url":"","childrenPages":[]}

Getting Started with the Orbirental API

This page will help you get started with Orbirental. You'll be up and running in a jiffy!

[block:image] { "images": [ { "image": [ "https://files.readme.io/fKAZpGIsTEePni9MFSWA_Orbirental_GGB_3.png", "Orbirental_GGB_3.png", "1000", "653", "#774518", "" ] } ] } [/block] ## Welcome to the **Orbirental API**! This API is still under development, but we're working hard to improve it! Please [contact us](https://www.orbirental.com) if you run into trouble. If you notice the docs are out of date or are unclear, please don't be shy about clicking the "Suggest Edits" link! We're working to keep these docs up to date, however sometimes we get behind – and we'd love your help. ## Prerequisites Access to the Orbirental API is granted to users with **Gold** or **Growth** accounts, or to organisations being part of the **Orbirental prefered partners**. If you need to upgrade your account to Gold level, you can do so from the page *Agency Settings > Account Upgrade*. If you want to apply to be a prefered partner, you can do so by sending an email to partner@orbirental.com. ## Authentication Authentication requires an API key, which can be acquired from your Agency Settings page. You will need to include your key in every request made to the API. The API key has have to be provided as an HTTP request header called *X-ORBIRENTAL-APIKEY*. ## Sandbox vs Production API development will always have to start on our sandbox. Once you feel that you got things under control, just send us a note and we'll enable your access to production. ## Support and Feedback Please feel free to send us suggestions or issues either through our Intercom channel or at support@orbirental.com.