{"_id":"56e3719c591f620e00bf509b","user":"56e371538b32a10e00f79750","__v":7,"githubsync":"","version":{"_id":"56e3719a591f620e00bf5098","hasReference":true,"hasDoc":true,"__v":6,"project":"56e3719a591f620e00bf5095","createdAt":"2016-03-12T01:32:10.751Z","releaseDate":"2016-03-12T01:32:10.751Z","categories":["56e3719b591f620e00bf5099","56e7b24ad365390e007baeab","59c952f57f6bea002e57da0a","59c954f07f6bea002e57da14","59cb3f6b487a0e00261deb5c","59cd714c360c8600242c4984"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"1.1.0","version":"1.1"},"parentDoc":null,"project":"56e3719a591f620e00bf5095","category":{"_id":"56e3719b591f620e00bf5099","pages":["56e3719c591f620e00bf509b","56e74226555c030e00a52a90","56e7447c7d693632001d5cb4","56e752bd56d59a0e00d5660e","56e755b98aa2c00e00494cd9","56e7584d911296190096dd80","56e759339b25270e001d11a0","56e7593e1b41040e009d10cf","56e7594e911296190096dd88","56e7595e8aa2c00e00494ce3","56e75d7f5669091700c5b2b4","56e77e22911296190096de13","56e77f259b25270e001d1232","56e7b2c737afb90e00e0eb9d","56ec4daf611730190000f23f","56ec4fde26db830e00afa083","56ec8f7204e8940e00966567","56f184cc9791b22d0077b9d9","56f18a2c3af4942b00bb3c47"],"project":"56e3719a591f620e00bf5095","__v":19,"version":"56e3719a591f620e00bf5098","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-03-12T01:32:11.359Z","from_sync":false,"order":0,"slug":"documentation","title":"Documentation"},"metadata":{"title":"","description":"","image":[]},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-03-12T01:32:12.211Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":0,"body":"[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/cfd1e93-hostfully-api.png\",\n        \"hostfully-api.png\",\n        907,\n        614,\n        \"#e9ecea\"\n      ]\n    }\n  ]\n}\n[/block]\n## Welcome to the **Hostfully API**!\n\nThis API is always under development. If you need help with implementing the API for your system, please contact our professional services [contact us](https://hello.hostfully.com/contact-us/) and we'll help you with your project.\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 Hostfully API is granted to users with **Premium**, **Gold** or **Growth** accounts, or to organizations being part of the **Hostfully preferred 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 preferred partner, you can do so by sending an email to support:::at:::hostfully.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## Rate Limit\nThe Hostfully API allows 1,000 calls within a 1 hour window per calling client (per api key).\n### HTTP Headers and Response Codes\n\nUse the HTTP headers in order to understand where the application is at for a given rate limit, on the method that was just utilized. The HTTP headers to monitor are the following:\n```\nx-ratelimit-limit: the rate limit ceiling for that given endpoint\nx-ratelimit-remaining: the number of requests left for the 15 minute window\n```\nWhen hitting the rate limit, please pause your code for 1 hour and retry the call.\n### Blacklisting\n\nIf a client application abuses the rate limits, it will be blacklisted. Blacklisted client apps are unable to get a response from the Hostfully API. If you or your application has been blacklisted and you think there has been a mistake, you can email us at support@hostfully.com to request assistance.\n\n## Support and Feedback\n\nPlease feel free to send us suggestions or issues either through our Intercom channel or at support@hostfully.com.","excerpt":"This page will help you get started with Hostfully. You'll be up and running in a jiffy!","slug":"getting-started","type":"basic","title":"Getting Started with the Hostfully API"}

Getting Started with the Hostfully API

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

[block:image] { "images": [ { "image": [ "https://files.readme.io/cfd1e93-hostfully-api.png", "hostfully-api.png", 907, 614, "#e9ecea" ] } ] } [/block] ## Welcome to the **Hostfully API**! This API is always under development. If you need help with implementing the API for your system, please contact our professional services [contact us](https://hello.hostfully.com/contact-us/) and we'll help you with your project. 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 Hostfully API is granted to users with **Premium**, **Gold** or **Growth** accounts, or to organizations being part of the **Hostfully preferred 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 preferred partner, you can do so by sending an email to support@hostfully.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. ## Rate Limit The Hostfully API allows 1,000 calls within a 1 hour window per calling client (per api key). ### HTTP Headers and Response Codes Use the HTTP headers in order to understand where the application is at for a given rate limit, on the method that was just utilized. The HTTP headers to monitor are the following: ``` x-ratelimit-limit: the rate limit ceiling for that given endpoint x-ratelimit-remaining: the number of requests left for the 15 minute window ``` When hitting the rate limit, please pause your code for 1 hour and retry the call. ### Blacklisting If a client application abuses the rate limits, it will be blacklisted. Blacklisted client apps are unable to get a response from the Hostfully API. If you or your application has been blacklisted and you think there has been a mistake, you can email us at support@hostfully.com to request assistance. ## Support and Feedback Please feel free to send us suggestions or issues either through our Intercom channel or at support@hostfully.com.