6/21/2023 0 Comments Api shift selectTo provide proof that you trulyĪre the sender of the request, you also include a digital signatureĬalculated using your secret Signature Key. Is used to authorize the requested action. Yourself as the sender of the request, and the associated API Account Key ID in all requests to the Shiftboard Web Services API to identify The Access Key ID is associated with an API Account which will beĪdded to your organization's Shiftboard. Shiftboard will ever ask you for your secret Signature Key. It in your requests to Shiftboard, and never e-mail it to anyone.ĭo not share it outside your organization, even if an inquiry appears It is important to keep it confidential to protect For example: bkvqNVSokbDZVHvt+RzqsrVzI0w7fhcU/jo/eUcYĬaution: Your Signature Key is a secret, which only you and Shiftboard.The first is the workgroup ID, and the second is the account ID of the member.įor more information, or to get a webhook configured for your site, please contact your Account Manager.īefore you use the Shiftboard Web Services API, you must registerĪn Access Key ID (a 36 character sequence) The ID can be the internal Shiftboard ID, the external Customer ID (if the site is configured to support that), or a customer-specified custom field on the shift object.įor shifts, ‘#’ is the ID of the shift.įor workgroup memberships, there are two IDs: ‘#/#’. For example, if the account.create endpoint is specified as ‘' then a notification will look like ‘’ where # is the ID of the newly created account. The webhook call is an HTTP GET request with the URL parameterized with the ID of the affected object. Supported events include the following:Įach of these events can be subscribed to independently (enabled/disabled and endpoint specified). Shiftboard can make an HTTP request to a customer-specified endpoint when specific events occur. Objects or extended functionality that can help meet the requirements The Shiftboard APIs are constantly evolving. In addition, various types of management functionality notĪvailable to end-users are exposed via the web service. In fact, all of Shiftboard's end-user applications use the Virtually every end-user interaction can be implemented using the Please see the Requests section for details on making Signature Key should NEVER be transmitted or shared with anyone. Request with your private (secret) Signature Key. These libraries should be available forĪll requests include your organization's unique Access Key ID andĪre digitally signed by computing an HMAC SHA1 signature of the Using JSON, HMAC, andīe easy to create, update, list and delete objects within the Notation ( JSON) and encrypted using 256-bit Shiftboard application, account, authorization, systems management,Īnd site provisioning data is accessible and the API is continuallyĮxtended to encompass more of the Shiftboard data and functionality.Īll requests and responses are encoded using JavaScript Object (APIs) to allow external systems to interact with the Shiftboard Shiftboard offers a rich set of Application Programming Interfaces availability.update (not currently available).
0 Comments
Leave a Reply. |