{"__v":13,"_id":"55a65a4251457325000e4d40","category":{"__v":13,"_id":"55a64fe680c8a30d00b325e0","pages":["55a652b680c8a30d00b325ec","55a65a4251457325000e4d40","55a6705b80c8a30d00b32686","55a772393efe0c2f0074c8fe","55a7ae383efe0c2f0074caaf","55ae2ba22723e51900898fa0","55ae32628576b92300291cb3","55b0b0bbe7abe62300f9a8bb","55b0c6def202b12100cda2e7","55bf80af19dd820d0008a006","55c06be7344dc40d00f55859","55c06ccb37298d0d00088c72","561d098a09e6540d002ff602"],"project":"54ad7b1d9219922100751796","version":"5505581f728deb23005ec0f4","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-07-15T12:19:50.489Z","from_sync":false,"order":1,"slug":"rest-api-coming-soon","title":"REST API"},"project":"54ad7b1d9219922100751796","user":"55a38410912a6e2300882b88","version":{"__v":4,"_id":"5505581f728deb23005ec0f4","forked_from":"54ad7b1d9219922100751799","project":"54ad7b1d9219922100751796","createdAt":"2015-03-15T09:59:59.748Z","releaseDate":"2015-03-15T09:59:59.748Z","categories":["55055820728deb23005ec0f5","55055820728deb23005ec0f6","554213dacbc48d0d001544ef","55421a598aeff51700a20db6","55a64fe680c8a30d00b325e0"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"2.0.0","version":"2.0"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-07-15T13:04:02.240Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":0,"body":"The vCita REST API allows access to the same data and actions that are available to a user in the vCita application. In order to ensure the security of your data all API calls to the vCita REST API must include an authentication token. \n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"1. Generating an Authentication Token\"\n}\n[/block]\nOnce granted access to the API, you can get an API Token that you can use to access the vCita REST API at  https://www.vcita.com/settings/business\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"2. Including the Authentication Token in API calls\"\n}\n[/block]\nThe vCita REST API requires that requests contain an additional HTTP Authorization header with the authentication token. The request would look similar to this:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"GET /v2/conversations HTTP/1.1\\nHost: api.vcita.com\\nAuthorization: Token 8da57c6ef736a9885bc5ea068280154a\\nCache-Control: no-cache\",\n      \"language\": \"text\"\n    }\n  ]\n}\n[/block]\n\nOnce you have generated an authentication token you can test to see that you are correctly making authenticated API calls by calling our test route. This is explained with some examples [here](doc:v2profile).","excerpt":"Description of authentication used by the vCita REST API","slug":"authentication","type":"basic","title":"REST API - Quickstart"}

REST API - Quickstart

Description of authentication used by the vCita REST API

The vCita REST API allows access to the same data and actions that are available to a user in the vCita application. In order to ensure the security of your data all API calls to the vCita REST API must include an authentication token. [block:api-header] { "type": "basic", "title": "1. Generating an Authentication Token" } [/block] Once granted access to the API, you can get an API Token that you can use to access the vCita REST API at https://www.vcita.com/settings/business [block:api-header] { "type": "basic", "title": "2. Including the Authentication Token in API calls" } [/block] The vCita REST API requires that requests contain an additional HTTP Authorization header with the authentication token. The request would look similar to this: [block:code] { "codes": [ { "code": "GET /v2/conversations HTTP/1.1\nHost: api.vcita.com\nAuthorization: Token 8da57c6ef736a9885bc5ea068280154a\nCache-Control: no-cache", "language": "text" } ] } [/block] Once you have generated an authentication token you can test to see that you are correctly making authenticated API calls by calling our test route. This is explained with some examples [here](doc:v2profile).