{"_id":"576d42354bcd290e00428958","project":"56a526d4e7a1622b0024fae4","editedParams2":true,"__v":0,"category":{"_id":"576d42354bcd290e00428944","__v":0,"version":"576d42354bcd290e00428941","project":"56a526d4e7a1622b0024fae4","sync":{"url":"","isSync":false},"reference":true,"createdAt":"2016-02-11T11:25:07.821Z","from_sync":false,"order":0,"slug":"objective-c","title":"Our API"},"editedParams":true,"parentDoc":null,"version":{"_id":"576d42354bcd290e00428941","project":"56a526d4e7a1622b0024fae4","__v":1,"createdAt":"2016-06-24T14:22:45.076Z","releaseDate":"2016-06-24T14:22:45.076Z","categories":["576d42354bcd290e00428942","576d42354bcd290e00428943","576d42354bcd290e00428944","576d42354bcd290e00428945","576d42354bcd290e00428946","576d42354bcd290e00428947"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"2.0.0","version":"2"},"user":"56bc6af27c91881900089bac","updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-02-11T15:41:41.154Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"method":"post","settings":"","auth":"never","params":[{"_id":"56bcabeee50b360d00984e04","ref":"","in":"body","required":false,"desc":"Your Chirp app key","default":"","type":"string","name":"app_key"},{"_id":"56bcabeee50b360d00984e03","ref":"","in":"body","required":false,"desc":"Your Chirp app secret","default":"","type":"string","name":"app_secret"},{"_id":"56bcabeee50b360d00984e02","ref":"","in":"body","required":false,"desc":"A unique RFC 4122 device UUID.","default":"","type":"string","name":"device_id"}],"url":"/authenticate"},"isReference":true,"order":2,"body":"[block:textarea]\n{\n  \"text\": \"## Request\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"import requests\\n\\nurl = 'https://api.chirp.io/v1/authenticate'\\npayload = {\\n  'app_key': 'my_app_key',\\n  'app_secret': 'my_app_secret',\\n  'device_id': 'my-unique-device-id',\\n}\\n\\nresponse = requests.post(url, json=payload)\",\n      \"language\": \"python\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n[block:textarea]\n{\n  \"text\": \"## Results\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"name\": 200,\n      \"code\": \"{\\n    \\\"access\\\": {\\n        \\\"analytics\\\": [\\n            \\\"create\\\",\\n            \\\"read\\\"\\n        ],\\n        \\\"chirps\\\": [\\n            \\\"create\\\",\\n            \\\"read\\\",\\n            \\\"say\\\",\\n            \\\"hear\\\"\\n        ]\\n    },\\n    \\\"access_token\\\": \\\"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\\\",\\n    \\\"expires_at\\\": \\\"2016-02-23T15:43:44.642000\\\"\\n}\",\n      \"language\": \"json\",\n      \"status\": 200\n    },\n    {\n      \"name\": 400,\n      \"code\": \"{\\n    \\\"status\\\": 400,\\n    \\\"description\\\": \\\"Bad Request: Invalid parameter(s).\\\",\\n    \\\"error\\\": true\\n}\",\n      \"language\": \"json\",\n      \"status\": 400\n    },\n    {\n      \"code\": \"{\\n    \\\"status\\\": 403,\\n    \\\"description\\\": \\\"Forbidden: Invalid credentials.\\\",\\n    \\\"error\\\": true\\n}\",\n      \"language\": \"json\",\n      \"status\": 403,\n      \"name\": 403\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","excerpt":"Authenticate your credentials on the Chirp API.","slug":"api-authenticate","type":"endpoint","title":"/authenticate"}

post/authenticate

Authenticate your credentials on the Chirp API.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

app_key:
string
Your Chirp app key
app_secret:
string
Your Chirp app secret
device_id:
string
A unique RFC 4122 device UUID.

Documentation

[block:textarea] { "text": "## Request", "sidebar": true } [/block] [block:code] { "codes": [ { "code": "import requests\n\nurl = 'https://api.chirp.io/v1/authenticate'\npayload = {\n 'app_key': 'my_app_key',\n 'app_secret': 'my_app_secret',\n 'device_id': 'my-unique-device-id',\n}\n\nresponse = requests.post(url, json=payload)", "language": "python" } ], "sidebar": true } [/block] [block:textarea] { "text": "## Results", "sidebar": true } [/block] [block:code] { "codes": [ { "name": 200, "code": "{\n \"access\": {\n \"analytics\": [\n \"create\",\n \"read\"\n ],\n \"chirps\": [\n \"create\",\n \"read\",\n \"say\",\n \"hear\"\n ]\n },\n \"access_token\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n \"expires_at\": \"2016-02-23T15:43:44.642000\"\n}", "language": "json", "status": 200 }, { "name": 400, "code": "{\n \"status\": 400,\n \"description\": \"Bad Request: Invalid parameter(s).\",\n \"error\": true\n}", "language": "json", "status": 400 }, { "code": "{\n \"status\": 403,\n \"description\": \"Forbidden: Invalid credentials.\",\n \"error\": true\n}", "language": "json", "status": 403, "name": 403 } ], "sidebar": true } [/block]

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}