{"_id":"59778bba32f043002002f5e2","category":{"_id":"59778bb932f043002002f5d4","version":"59778bb932f043002002f5d3","project":"5425e663ffd4411c319a65b4","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2014-09-26T23:22:58.179Z","from_sync":false,"order":0,"slug":"getting-started","title":"Getting Started"},"user":"5425e31affd4411c319a65b1","project":"5425e663ffd4411c319a65b4","version":{"_id":"59778bb932f043002002f5d3","project":"5425e663ffd4411c319a65b4","__v":1,"createdAt":"2017-07-25T18:19:37.272Z","releaseDate":"2017-07-25T18:19:37.272Z","categories":["59778bb932f043002002f5d4","59778bb932f043002002f5d5"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"2.5.0","version":"2.5"},"__v":0,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2014-09-26T23:00:29.593Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[]},"auth":"never","params":[],"url":""},"isReference":false,"order":1,"body":"All requests must be authenticated using one of your organization’s API keys. \n\nAdministrators can create and maintain API keys through the settings menu in the dashboard, by going into the [API section](http://support.onfleet.com/hc/en-us/articles/203798149-API).\n\nYou can create as many API keys as required to suit your different applications and environments. A valid key must be provided with every request, via HTTP [basic access authentication](https://en.wikipedia.org/wiki/Basic_access_authentication), where the key string is the **username** of the request, and the **password** is blank. \n\nIf you need a separate organization for testing purposes, please contact us at [support:::at:::onfleet.com](mailto:support@onfleet.com).\n[block:api-header]\n{\n  \"type\": \"get\",\n  \"title\": \"Testing your API key\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:textarea]\n{\n  \"text\": \"You can use the `/auth/test` endpoint to check that you are formatting your request correctly and that your API key is valid.\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"$ curl -X GET \\\"https://onfleet.com/api/v2/auth/test\\\" \\\\\\n       -u \\\"cd3b3de84cc1ee040bf06512d233719c:\\\"\",\n      \"language\": \"shell\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"message\\\": \\\"Hello organization 'yAM*fDkztrT3gUcz9mNDgNOL' hitting Onfleet from 188.15.204.82\\\"\\n}\",\n      \"language\": \"json\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","excerpt":"","slug":"authentication","type":"basic","title":"Authentication"}
All requests must be authenticated using one of your organization’s API keys. Administrators can create and maintain API keys through the settings menu in the dashboard, by going into the [API section](http://support.onfleet.com/hc/en-us/articles/203798149-API). You can create as many API keys as required to suit your different applications and environments. A valid key must be provided with every request, via HTTP [basic access authentication](https://en.wikipedia.org/wiki/Basic_access_authentication), where the key string is the **username** of the request, and the **password** is blank. If you need a separate organization for testing purposes, please contact us at [support@onfleet.com](mailto:support@onfleet.com). [block:api-header] { "type": "get", "title": "Testing your API key", "sidebar": true } [/block] [block:textarea] { "text": "You can use the `/auth/test` endpoint to check that you are formatting your request correctly and that your API key is valid.", "sidebar": true } [/block] [block:code] { "codes": [ { "code": "$ curl -X GET \"https://onfleet.com/api/v2/auth/test\" \\\n -u \"cd3b3de84cc1ee040bf06512d233719c:\"", "language": "shell" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"message\": \"Hello organization 'yAM*fDkztrT3gUcz9mNDgNOL' hitting Onfleet from 188.15.204.82\"\n}", "language": "json" } ], "sidebar": true } [/block]