Accessing the REST API Module
Winmore offers a REST API to allow our customers to access and manage their data through an HTTP request. Information can be found under the REST API Explorer tile, which can be accessed by customer administrators through the Studio Menu. If you do not see this option, please speak with your Customer Success Manager.
Under this section, you will find a list of all the Record Types in your system and can click on them to review the information available in each. For example, you can see all available fields, API Name and field types.
Scrolling down in the far right pane, you will also find information on how to get a list of the records as well as retrieve, create, update and delete selected records. Each call type is accompanied by an example request that you can copy by clicking on the copy icon.
Winmore API Rate Guidance
To ensure service levels and quality, developers must manage/restrict the number of API calls to the Winmore service to a reasonable rate.
As a general guidance, API calls to a particular Winmore customer account should be restricted to no more than:
60 requests per minute.
500 requests per hour.
5,000 requests per day.
If Winmore receives more than the number of requests mentioned above, the request will be rejected and you will receive a 429 error. While these rate limits are not enforced, higher rates than these may impact quality of service. Winmore may change this guidance at any time. As with any APIs, the Winmore APIs may change over time. When possible, we will provide developers with advance notification when an API will be deprecated.
REST API Metering
- The initial request should use basic authentication with a username and password
- Subsequent requests need to pass back an access token returned by the first authenticated response
- Once the token expires the next request should send the username and password; the token expiry check will need to take place on the client's side
- Please talk to us about your application needs so we can set an appropriate token expiry time
- Please see the “Winmore API Rate Guidance” section above for limits on number of REST calls per time period (minute/hour/day)
- Response headers will provide you information about the number or remaining requests available per time period. Please see a list of headers and a brief explanation of the data in each header
- x-ratelimit-reset-minute: the remaining window before the rate limit resets, in UTC epoch seconds
- x-ratelimit-limit-minute: the rate limit ceiling for that given endpoint
- x-ratelimit-remaining-minute: the number of requests left for the minute window
- x-ratelimit-reset-hour: the remaining window before the rate limit resets, in UTC epoch seconds
- x-ratelimit-limit-hour: the rate limit ceiling for that given endpoint
- x-ratelimit-remaining-hour: the remaining window before the rate limit resets, in UTC epoch seconds
- x-ratelimit-reset-day: the remaining window before the rate limit resets, in UTC epoch seconds
- x-ratelimit-limit-day: the rate limit ceiling for that given endpoint
- x-ratelimit-remaining-day: the remaining window before the rate limit resets, in UTC epoch seconds