The ReadyOp REST API allows developers to query and manage data about your ReadyOp agencies such as, contacts, users, etc. The ReadyOp API is based on basic REST principles making it very easy to develop, and test applications. To make things even easier, you can even use your browser to access the URL’s and use almost any HTTP client in any programming language to create your application with the API.
All URLs referenced in the documentation have the following base in which you should replace [sitename] with your ReadyOp site name:
https://[Site Name].readyop.com/api/2013-12-01/
The ReadyOp REST API is only accessible over HTTPS. For maximum security, unencrypted HTTP is not supported.
About REST (REpresentational State Transfer)
We designed the ReadyOp API based on the basic principles of REST. From Wikipedia:
REST’s proponents argue that the Web’s scalability and growth are a direct result of a few key design principles:
- Application state and functionality are divided into resources
- Every resource is uniquely addressable using a universal syntax for use in hypermedia links
- All resources share a uniform interface for the transfer of state between client and resource, consisting of
- A constrained set of well-defined operations
- A constrained set of content types, optionally supporting code on demand
- A protocol which is:
- Client-server
- Stateless
- Cacheable
- Layered
REST’s client/server separation of concerns simplifies component implementation, reduces the complexity of connector semantics, improves the effectiveness of performance tuning, and increases the scalability of pure server components. Layered system constraints allow intermediaries-proxies, gateways, and firewalls-to be introduced at various points in the communication without changing the interfaces between components, thus allowing them to assist in communication translation or improve performance via large-scale, shared caching.
REST enables intermediate processing by constraining messages to be self-descriptive: interaction is stateless between requests, standard methods and media types are used to indicate semantics and exchange information, and responses explicitly indicate cacheability.
If you’re looking for more information about RESTful web services, the O’Reilly RESTful Web Services book is excellent.