{"_id":"5b0f10fb65473500031e63ea","category":"5b0f10fb65473500031e63db","user":"543458470ef9c00800164ced","project":"548ea7a5e52d2b0b001b9a10","parentDoc":null,"version":"5b0f10fb65473500031e641e","updates":[],"next":{"pages":[],"description":""},"createdAt":"2014-12-15T09:19:34.631Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":0,"body":"[block:callout]\n{\n  \"type\": \"success\",\n  \"title\": \"What's New in Version 3.8\",\n  \"body\": \"- [Shipments](doc:shipment-schema) now have a `sales_order_number` field\"\n}\n[/block]\nCaseStack's RESTful APIs allow for seamless integration between your applications and our Supply Chain Management Platform.\n\nWe offer full duplex connectivity. REST calls allows pushing data into the system. API updates will be applied across all active browser sessions simultaneously.\n\nWebhooks allow for asynchronous, real-time notification of events happening within your supply chain.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Get Your API Keys\",\n  \"body\": \"You can generate your API keys and set the webhook callback URL under the [Settings](https://app.casestack.io/#/settings/api) tab in the TMS.\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Authentication\"\n}\n[/block]\nThe API supports Basic Authentication ([RFC-2617](http://www.ietf.org/rfc/rfc2617.txt)) over SSL. \n\nFor Example:\n\n```https://username:password:::at:::app.casestack.io/api/carrier```\n\nWhere `username` is the unique 24 character (12 byte) string assigned to your company and\n `password` is the secret API key that was generated.  \n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Rate Limiting\"\n}\n[/block]\nThe API endpoints implement [Token Bucket](http://en.wikipedia.org/wiki/Token_bucket) rate limiting. \n\nRequests are capped at 10 reqs/sec, with a burst of 100 requests.  Rate Limits are imposed across all services consuming the API from your organization, instead of a per IP basis.\n\nIf you would like to increase the limit, please contact [support@casestack.io](mailto:support@casestack.io)\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Versions\"\n}\n[/block]\nThe endpoints employ [semver](http://semver.org/) versioning. \n\nYou can specify the version you are requesting in the ```Accept-Version``` header.","excerpt":"This page will help you get started with the CaseStack API.","slug":"getting-started","type":"basic","title":"Getting Started","__v":0,"childrenPages":[]}

Getting Started

This page will help you get started with the CaseStack API.

[block:callout] { "type": "success", "title": "What's New in Version 3.8", "body": "- [Shipments](doc:shipment-schema) now have a `sales_order_number` field" } [/block] CaseStack's RESTful APIs allow for seamless integration between your applications and our Supply Chain Management Platform. We offer full duplex connectivity. REST calls allows pushing data into the system. API updates will be applied across all active browser sessions simultaneously. Webhooks allow for asynchronous, real-time notification of events happening within your supply chain. [block:callout] { "type": "info", "title": "Get Your API Keys", "body": "You can generate your API keys and set the webhook callback URL under the [Settings](https://app.casestack.io/#/settings/api) tab in the TMS." } [/block] [block:api-header] { "type": "basic", "title": "Authentication" } [/block] The API supports Basic Authentication ([RFC-2617](http://www.ietf.org/rfc/rfc2617.txt)) over SSL. For Example: ```https://username:password@app.casestack.io/api/carrier``` Where `username` is the unique 24 character (12 byte) string assigned to your company and `password` is the secret API key that was generated. [block:api-header] { "type": "basic", "title": "Rate Limiting" } [/block] The API endpoints implement [Token Bucket](http://en.wikipedia.org/wiki/Token_bucket) rate limiting. Requests are capped at 10 reqs/sec, with a burst of 100 requests. Rate Limits are imposed across all services consuming the API from your organization, instead of a per IP basis. If you would like to increase the limit, please contact [support@casestack.io](mailto:support@casestack.io) [block:api-header] { "type": "basic", "title": "Versions" } [/block] The endpoints employ [semver](http://semver.org/) versioning. You can specify the version you are requesting in the ```Accept-Version``` header.