{"_id":"56169ba4a6767c0d00166a46","user":"556cbb50c14029190092d20f","parentDoc":null,"__v":7,"category":{"_id":"556cd8afc14029190092d296","pages":["556cd8b0c14029190092d298","55fc80353c21291900e7e0b0","55fc86873c21291900e7e0bd","55fc87be4ee5911900d357a9","55fdacf3b652110d00758b68","55fdae0f51dbf70d00c61bb8","55fdaf4156d6990d00a6cac5","560efa0743ea130d00a3621a","56169ba4a6767c0d00166a46","56aa75e24350eb17009147b5"],"__v":10,"project":"556cd8aec14029190092d292","version":"556cd8aec14029190092d295","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-06-01T22:11:59.312Z","from_sync":false,"order":1,"slug":"about-the-api","title":"About The API"},"project":"556cd8aec14029190092d292","version":{"_id":"556cd8aec14029190092d295","__v":14,"project":"556cd8aec14029190092d292","createdAt":"2015-06-01T22:11:58.756Z","releaseDate":"2015-06-01T22:11:58.756Z","categories":["556cd8afc14029190092d296","55ca5a55241e790d004f47ea","55dc9fdb4f535537007da1b2","55dc9fdfc755b63700dc843c","55fdb08c4bebdf17004130d4","560ef4c2a36c610d00e7013e","5613db296a092921004c30c2","56156581dc8aea0d002475e8","56169d1ee98f5517005627a8","5622fde7de7dc01700c6dd5f","56cf75f3336aa60b0086a495","5818f3c02093901b00bcf91a","582f7ff88ea0800f0035639a","583f30c110448a2500dd990f"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-10-08T16:36:52.874Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":2,"body":"This is an interactive version of our API based off of our Swagger documentation. You can the links below to test out the API. Keep in mind that you'll need an to [create an app](https://reverb.com/apps/new) to use the interactive documentation.\n\nTo use the interactive mode:\n\n1. [Create an app.](https://reverb.com/apps/new)\n2. Copy and paste your client id and client secret at the top of the page.\n\n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/52e30f2-Swagger_UI.png\",\n        \"Swagger_UI.png\",\n        1004,\n        133,\n        \"#d5d7d1\"\n      ]\n    }\n  ]\n}\n[/block]\n3. Go to the endpoint you want to test in swagger.\n4. Click on the \"off\" slider on the right side.\n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/8439dc2-image.png\",\n        \"image.png\",\n        1112,\n        332,\n        \"#eaf2fa\"\n      ]\n    }\n  ]\n}\n[/block]\n5. Select which scopes you want to use and click \"authorize\".\n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/e432add-image_1.png\",\n        \"image (1).png\",\n        525,\n        675,\n        \"#d4d0cb\"\n      ]\n    }\n  ]\n}\n[/block]\nYou should now be authorized to use that endpont:\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/5cc79ea-image_2.png\",\n        \"image (2).png\",\n        1106,\n        333,\n        \"#eaf2fa\"\n      ]\n    }\n  ]\n}\n[/block]\n6. You can now test that endpoint interactively.\n\n[Learn more about Reverb API authentication](doc:authentication) \n\n[block:embed]\n{\n  \"html\": false,\n  \"url\": \"https://reverb.com/swagger\",\n  \"title\": \"Swagger UI\",\n  \"favicon\": \"https://reverb.com/favicon.ico\",\n  \"iframe\": true,\n  \"height\": \"3000\"\n}\n[/block]","excerpt":"","slug":"swagger","type":"basic","title":"Interactive API Reference (Swagger)"}

Interactive API Reference (Swagger)


This is an interactive version of our API based off of our Swagger documentation. You can the links below to test out the API. Keep in mind that you'll need an to [create an app](https://reverb.com/apps/new) to use the interactive documentation. To use the interactive mode: 1. [Create an app.](https://reverb.com/apps/new) 2. Copy and paste your client id and client secret at the top of the page. [block:image] { "images": [ { "image": [ "https://files.readme.io/52e30f2-Swagger_UI.png", "Swagger_UI.png", 1004, 133, "#d5d7d1" ] } ] } [/block] 3. Go to the endpoint you want to test in swagger. 4. Click on the "off" slider on the right side. [block:image] { "images": [ { "image": [ "https://files.readme.io/8439dc2-image.png", "image.png", 1112, 332, "#eaf2fa" ] } ] } [/block] 5. Select which scopes you want to use and click "authorize". [block:image] { "images": [ { "image": [ "https://files.readme.io/e432add-image_1.png", "image (1).png", 525, 675, "#d4d0cb" ] } ] } [/block] You should now be authorized to use that endpont: [block:image] { "images": [ { "image": [ "https://files.readme.io/5cc79ea-image_2.png", "image (2).png", 1106, 333, "#eaf2fa" ] } ] } [/block] 6. You can now test that endpoint interactively. [Learn more about Reverb API authentication](doc:authentication) [block:embed] { "html": false, "url": "https://reverb.com/swagger", "title": "Swagger UI", "favicon": "https://reverb.com/favicon.ico", "iframe": true, "height": "3000" } [/block]