usage

REST APIs like the ZimpleMoney API are stateless, no "memory" is held at the system level from one request to the next. Each request is self-contained, all the information needed for the request is passed in the request path (the "endpoint"), the request type (GET, PUT, POST, or DELETE), and any parameters which may be passed as part of the request.

As noted in the discussion about authentication, most API requests require an authorization token to be passed, and return an [updated] authorization token. Some session state is held in these tokens, for purposes of efficiency.

Request parameters are always encoded as JSON. The specific parameters accepted by each endpoint are described in the API detail documentation.

Each request receives a single response back from the API. The response includes a response code (2xx for success, 4xx for an exception, and 5xx for an error), and many responses include data which are always encoded as JSON. The specific responses returned by each endpoint are described in the the API detail documentation.

Next: Error handling