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.
While these rate limits are not enforced, higher rates than these may impact quality of service. Winmore may change this guidance at any time.
If your application requires a higher API rate, contact Winmore Customer Success.
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.
*Our Authentication Service has a 20 request per minute limit when those requests are coming from the same username, password and IP address. If you find you find that this limit is interfering with your RESTAPI, please contact email@example.com.