{"_id":"59c07ea1a00f90001cd75cb6","category":{"_id":"59c07ea1a00f90001cd75cb2","version":"59c07ea1a00f90001cd75cb1","project":"56c27a9a2be66d19008d618d","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-02-16T01:25:47.579Z","from_sync":false,"order":0,"slug":"documentation","title":"Home"},"parentDoc":null,"project":"56c27a9a2be66d19008d618d","user":"56c27a665da27c17003df001","version":{"_id":"59c07ea1a00f90001cd75cb1","project":"56c27a9a2be66d19008d618d","__v":1,"createdAt":"2017-09-19T02:19:13.858Z","releaseDate":"2017-09-19T02:19:13.858Z","categories":["59c07ea1a00f90001cd75cb2","59c07ea1a00f90001cd75cb3"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"Rose","version_clean":"5.1.0","version":"5.1"},"githubsync":"","__v":0,"updates":["56ebcf51a059e33200361e92"],"next":{"pages":[],"description":""},"createdAt":"2016-02-16T01:48:56.841Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":2,"body":"The Zyllem API uses API keys to control the access rights of applications that connect to it. \n\nTo obtain authorization, generate at least one [API keys](doc:getting-started#3-generate-your-api-key) on the web portal. Then, attach the API key as a query parameter named `key` to all your calls to the API.\n\nYou may use the `/ping` resource to test the connectivity to the Zyllem API:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"GET /api/ping?key=my-api-key HTTP/1.1\\nHost: my-company.zyllem.com\\nContent-Type: application/json\",\n      \"language\": \"http\",\n      \"name\": \"HTTP\"\n    },\n    {\n      \"code\": \"curl -X GET \\\\\\n  'https://my-company.zyllem.com/api/ping?key=my-api-key' \\\\\\n  -H 'content-type: application/json'\",\n      \"language\": \"curl\",\n      \"name\": \"cURL\"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"\"\n}\n[/block]\n##:fa-life-ring:  [Ask a question](https://developer.zyllem.com/discuss)","excerpt":"All you need to know about Zyllem API authorization","slug":"authorization-101","type":"basic","title":"Authorization 101"}

Authorization 101

All you need to know about Zyllem API authorization

The Zyllem API uses API keys to control the access rights of applications that connect to it. To obtain authorization, generate at least one [API keys](doc:getting-started#3-generate-your-api-key) on the web portal. Then, attach the API key as a query parameter named `key` to all your calls to the API. You may use the `/ping` resource to test the connectivity to the Zyllem API: [block:code] { "codes": [ { "code": "GET /api/ping?key=my-api-key HTTP/1.1\nHost: my-company.zyllem.com\nContent-Type: application/json", "language": "http", "name": "HTTP" }, { "code": "curl -X GET \\\n 'https://my-company.zyllem.com/api/ping?key=my-api-key' \\\n -H 'content-type: application/json'", "language": "curl", "name": "cURL" } ] } [/block] [block:api-header] { "type": "basic", "title": "" } [/block] ##:fa-life-ring: [Ask a question](https://developer.zyllem.com/discuss)