{"_id":"56ad4897c00d120d00744350","user":"56acd6caa040860d00ac94a2","category":{"_id":"56acd8f95ac4060d0027865e","__v":7,"project":"56acd71213ac890d001c3c7a","version":"56acd71213ac890d001c3c7d","pages":["56ad4897c00d120d00744350","56afce739d32e30d0006d3b5","56afd4573a5b810d00745d77","56afd5049d32e30d0006d3bf","56afdc7d9d32e30d0006d3c5","56afdda49d32e30d0006d3c8","56b136c636d2580d002478d2"],"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-01-30T15:38:33.013Z","from_sync":false,"order":2,"slug":"restful-api","title":"REST API"},"project":"56acd71213ac890d001c3c7a","githubsync":"","parentDoc":null,"__v":6,"version":{"_id":"56acd71213ac890d001c3c7d","project":"56acd71213ac890d001c3c7a","__v":15,"createdAt":"2016-01-30T15:30:26.928Z","releaseDate":"2016-01-30T15:30:26.928Z","categories":["56acd71313ac890d001c3c7e","56acd8f113ac890d001c3c81","56acd8f95ac4060d0027865e","56acd93a13ac890d001c3c82","56ad20660ab3c00d00ce3347","56ad356a2a7860170013f714","56ad47eb0ab3c00d00ce334f","56afd523bc304a0d00ace1df","56b29a019621f20d00efb37e","56b657e11bc6970d009feee7","5845cc3c39950c1b002afe77","5845cde163c11b250037967e","5846efd45d064323007b17b4","588604da4674e32300efd160","588627882393d50f00f1322c"],"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":"2016-01-30T23:34:47.973Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[]},"auth":"required","params":[],"url":""},"isReference":false,"order":0,"body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Who Should use the REST API?\",\n  \"body\": \"GameWisp's REST API is intended for applications and uses that don't require repeated polling on endpoints. If you need to poll, use [Singularity](https://gamewisp.readme.io/docs/introduction). \\n\\nIt's also possible to use the REST API and Singularity within the same application.\"\n}\n[/block]\nThe REST API exposes some common resources that are central to the GameWisp platform. Currently it is read only, and all endpoints require a channel's OAuth2 access token. Currently, all endpoints require the **read_only** scope. \n\nThe current accessible resources are:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Resource\",\n    \"h-1\": \"Base Endpoint\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"Channel\",\n    \"0-1\": \"/api/pub/v1/channel/*\",\n    \"0-2\": \"The GameWisp channel resource, contains identifying information about a channel, its subscribers, tiers, and benefits.\",\n    \"1-0\": \"User\",\n    \"1-1\": \"/api/pub/v1/user/*\",\n    \"1-2\": \"The User resource contains information users and their subscriptions.\",\n    \"2-0\": \"Tier (coming soon)\",\n    \"2-1\": \"/api/pub/v1/tier/*\",\n    \"2-2\": \"Contains tier information for GameWisp channels, such as cost, titles, benefits, etc.\",\n    \"3-0\": \"Benefit (coming soon)\",\n    \"3-1\": \"/api/pub/v1/benefit/*\",\n    \"3-2\": \"Benefit information for channels and subscribers.\"\n  },\n  \"cols\": 3,\n  \"rows\": 2\n}\n[/block]","excerpt":"Don't need real-time updates? More comfortable with REST? Check out our REST API.","slug":"introduction-1","type":"basic","title":"Introduction"}

Introduction

Don't need real-time updates? More comfortable with REST? Check out our REST API.

[block:callout] { "type": "info", "title": "Who Should use the REST API?", "body": "GameWisp's REST API is intended for applications and uses that don't require repeated polling on endpoints. If you need to poll, use [Singularity](https://gamewisp.readme.io/docs/introduction). \n\nIt's also possible to use the REST API and Singularity within the same application." } [/block] The REST API exposes some common resources that are central to the GameWisp platform. Currently it is read only, and all endpoints require a channel's OAuth2 access token. Currently, all endpoints require the **read_only** scope. The current accessible resources are: [block:parameters] { "data": { "h-0": "Resource", "h-1": "Base Endpoint", "h-2": "Description", "0-0": "Channel", "0-1": "/api/pub/v1/channel/*", "0-2": "The GameWisp channel resource, contains identifying information about a channel, its subscribers, tiers, and benefits.", "1-0": "User", "1-1": "/api/pub/v1/user/*", "1-2": "The User resource contains information users and their subscriptions.", "2-0": "Tier (coming soon)", "2-1": "/api/pub/v1/tier/*", "2-2": "Contains tier information for GameWisp channels, such as cost, titles, benefits, etc.", "3-0": "Benefit (coming soon)", "3-1": "/api/pub/v1/benefit/*", "3-2": "Benefit information for channels and subscribers." }, "cols": 3, "rows": 2 } [/block]