{"_id":"56aff08d3a5b810d00745d9f","user":"566887ff8639090d00759415","hidden":false,"isReference":false,"order":0,"slug":"getting-started","sync_unique":"","title":"Getting Started with Boomtrain","type":"basic","version":"56aff08c3a5b810d00745d9c","body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"RESTful APIs\"\n}\n[/block]\nBoomtrain provides a RESTful API with endpoints for interacting with people, resources, events, and recommendations.\n\nThe API can be accessed using the standard HTTP request methods `GET`, `POST`, and `PUT`. There are several endpoints that can be used to manage events, resources, and users.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Authorization\"\n}\n[/block]\nAuthorization for Boomtrain APIs are is granted via JSON Web Token (JWT) [JSON Web Token](http://jwt.io/). To access these routes, supply a bearer token to the route as part of an *Authorization* header. You can generate a JSON Web Token by requesting one using our [Authorization API](https://boomtrain.readme.io/docs/authorization-api).\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Rate Limits\"\n}\n[/block]\nRate limiting is implemented on our REST APIs to protect against abuse. These rates vary by route:\n\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"customers.api.boomtrain.com\",\n    \"h-0\": \"Route Path\",\n    \"h-1\": \"Rate Limit\",\n    \"0-1\": \"10 per second\",\n    \"1-1\": \"10 per second\",\n    \"1-0\": \"metrics.api.boomtrain.com\",\n    \"2-0\": \"people.api.boomtrain.com\",\n    \"2-1\": \"10 per second\",\n    \"3-0\": \"events.api.boomtrain.com\",\n    \"3-1\": \"For [Get Recent Activity For a Specific User](https://boomtrain.readme.io/docs/get-recent-events-for-a-specific-person), 10 per second, otherwise unlimited\",\n    \"4-0\": \"resources.api.boomtrain.com\",\n    \"4-1\": \"50 per second\"\n  },\n  \"cols\": 2,\n  \"rows\": 5\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Need Help?\"\n}\n[/block]\nIf you have any questions or would like to learn more, don't hesitate to reach out to us!","category":"56aff08d3a5b810d00745d9d","createdAt":"2016-02-01T23:55:57.956Z","link_external":false,"parentDoc":null,"project":"56aff08c3a5b810d00745d99","updates":[],"githubsync":"","link_url":"","__v":8,"api":{"auth":"required","params":[],"results":{"codes":[]},"settings":"","url":""},"excerpt":"This page will help you get started with Boomtrain. You'll be up and running in a jiffy!","childrenPages":[]}

Getting Started with Boomtrain

This page will help you get started with Boomtrain. You'll be up and running in a jiffy!

[block:api-header] { "type": "basic", "title": "RESTful APIs" } [/block] Boomtrain provides a RESTful API with endpoints for interacting with people, resources, events, and recommendations. The API can be accessed using the standard HTTP request methods `GET`, `POST`, and `PUT`. There are several endpoints that can be used to manage events, resources, and users. [block:api-header] { "type": "basic", "title": "Authorization" } [/block] Authorization for Boomtrain APIs are is granted via JSON Web Token (JWT) [JSON Web Token](http://jwt.io/). To access these routes, supply a bearer token to the route as part of an *Authorization* header. You can generate a JSON Web Token by requesting one using our [Authorization API](https://boomtrain.readme.io/docs/authorization-api). [block:api-header] { "type": "basic", "title": "Rate Limits" } [/block] Rate limiting is implemented on our REST APIs to protect against abuse. These rates vary by route: [block:parameters] { "data": { "0-0": "customers.api.boomtrain.com", "h-0": "Route Path", "h-1": "Rate Limit", "0-1": "10 per second", "1-1": "10 per second", "1-0": "metrics.api.boomtrain.com", "2-0": "people.api.boomtrain.com", "2-1": "10 per second", "3-0": "events.api.boomtrain.com", "3-1": "For [Get Recent Activity For a Specific User](https://boomtrain.readme.io/docs/get-recent-events-for-a-specific-person), 10 per second, otherwise unlimited", "4-0": "resources.api.boomtrain.com", "4-1": "50 per second" }, "cols": 2, "rows": 5 } [/block] [block:api-header] { "type": "basic", "title": "Need Help?" } [/block] If you have any questions or would like to learn more, don't hesitate to reach out to us!