{"_id":"582789abbe5c080f00a5a821","version":{"_id":"582789aabe5c080f00a5a7fe","__v":10,"project":"568bdc1483d2061900d86cdc","createdAt":"2016-11-12T21:29:14.915Z","releaseDate":"2016-11-12T21:29:14.915Z","categories":["582789abbe5c080f00a5a7ff","582789abbe5c080f00a5a800","582789abbe5c080f00a5a801","582789abbe5c080f00a5a802","582789abbe5c080f00a5a803","582789abbe5c080f00a5a804","582789abbe5c080f00a5a805","582789abbe5c080f00a5a806","582789abbe5c080f00a5a807","582789abbe5c080f00a5a808","5827ea984ca29e0f00137a9e","583df597887db62f00644283","583df5d9c622791900e78da5","5845cd8763c11b250037967d","5845d13063c11b2500379681","5859e859e3306d1900126725","587aeb9a01cf3a0f008359eb","587c422af45e2d0f005e200d","587d84dc82f6f30f004ceee5"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"beta2","version_clean":"0.0.0","version":"0"},"parentDoc":null,"user":"568bdbc4fe6fcc0d006dc970","project":"568bdc1483d2061900d86cdc","category":{"_id":"587aeb9a01cf3a0f008359eb","project":"568bdc1483d2061900d86cdc","version":"582789aabe5c080f00a5a7fe","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2017-01-15T03:25:14.326Z","from_sync":false,"order":3,"slug":"using-the-api","title":"Using the API"},"__v":0,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-05-17T20:38:55.137Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":0,"body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Introduction\"\n}\n[/block]\nThe Droplit API supports using specific versions by specifying the version in the URL after the domain name in the form of `v0`, `v1`, etc.\n\nExample: `https://ioe.droplit.io/v0/…`, `https://ioe.droplit.io/v1/…`, etc.\n\nYou may reference the most current stable version of the API by not specifying a version.\n\nWhere the current stable version of the API is `v1`, the following URLs are equivalent.\n\nWith version: `https://ioe.droplit.io/v1/api/devices`\n\nWithout version: `https://ioe.droplit.io/api/devices`\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Work with the latest and greatest\"\n}\n[/block]\nIt is recommended that you code against the most current version by not specifying a version. When new API versions are released, you will be notified at your developer email address with plenty of advanced notice to update your application from any breaking changes.\n\nThe best practice is to always work with the latest version of an API. Being the spirited and fastidious team that you are; you have a dedication to the idea of keeping your application up to date. Furthermore, an old API version will generally only be supported for a year after it is replaced by a new version.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Version Header\"\n}\n[/block]\nIt is recommended (but not required) that you include an `x-api-version` header with a version number in the form of `v0`, `v1`, etc. with all HTTP requests.\n\n`x-api-version: v1`\n\nThis will give us a way to know that an application which has not been updated still exists in the wild. We may email and call you incessantly to tell you that your application will break.","excerpt":"Designating a specific API version","slug":"api-version","type":"basic","title":"API Version"}

API Version

Designating a specific API version

[block:api-header] { "type": "basic", "title": "Introduction" } [/block] The Droplit API supports using specific versions by specifying the version in the URL after the domain name in the form of `v0`, `v1`, etc. Example: `https://ioe.droplit.io/v0/…`, `https://ioe.droplit.io/v1/…`, etc. You may reference the most current stable version of the API by not specifying a version. Where the current stable version of the API is `v1`, the following URLs are equivalent. With version: `https://ioe.droplit.io/v1/api/devices` Without version: `https://ioe.droplit.io/api/devices` [block:api-header] { "type": "basic", "title": "Work with the latest and greatest" } [/block] It is recommended that you code against the most current version by not specifying a version. When new API versions are released, you will be notified at your developer email address with plenty of advanced notice to update your application from any breaking changes. The best practice is to always work with the latest version of an API. Being the spirited and fastidious team that you are; you have a dedication to the idea of keeping your application up to date. Furthermore, an old API version will generally only be supported for a year after it is replaced by a new version. [block:api-header] { "type": "basic", "title": "Version Header" } [/block] It is recommended (but not required) that you include an `x-api-version` header with a version number in the form of `v0`, `v1`, etc. with all HTTP requests. `x-api-version: v1` This will give us a way to know that an application which has not been updated still exists in the wild. We may email and call you incessantly to tell you that your application will break.