...
- Test if server up
https://grouperws.whatever.school.edu/grouper-ws/status?diagnosticType=all
https://grouperws.whatever.school.edu/grouper-ws/servicesRest/v2_6_000/subjects?wsLiteObjectType=WsRestGetSubjectsLiteRequest&searchString=GrouperSystem - Code clients with a mindset that the service might change in subtle ways. e.g. a result code might be added (check for success flag element, not success result code), an element might be added in a result object, another input element might be added to end of list, etc. Expect elements to be added in data. Note if you send the same version in the request, you will never get a response with a different structure. Grouper WS are backwards compatible.
- Make sure there is a property in the client of the URL and version for the service. The version of the service might change the URL (up to service deployer)...
- Note that Grouper WS can be setup with multiple instances. If you have database replication (even readonly), then you can setup Grouper WS application servers is multiple data centers, and you can have the Grouper Client can failover among the nodes if there are errors or timeouts.
Features
- API
- Batched operations (e.g. add 100 subjects to a group at once). There is a separate server-side max-in-batch param in the grouper-ws.properties.
- Transaction support (if any fails in one batch request, rollback all in that single batch request)
- Authentication
- Let container or web server handle
o PKI
o http-simple-auth
o Source IP address filtering (TODO) - Custom authenticator
- JWT
- LDAP authn
- Proxying. The web service can execute operations based on an underlying user, not the authenticating user. Note the authenticating user must have appropriate permissions
- Let container or web server handle
- Error Handling
- Error codes and error messages are sent in responses, as well as warnings. In batched mode, batches of response codes are returned. In REST, the http status code is used as well.
...