Using the Web Service
- a requested URL (or “endpoint”)
- a method
- headers
- the data (or “body”)
The endpoint
The endpoint (root-endpoint) of the API is: https://secure.lyra.com/sdd.
Several resources, each associated with a different path, are provided:
| Action | Method | URl |
|---|---|---|
| Import an existing mandate | POST | /mandates |
| Import several existing mandates | POST | /multimandates |
| View mandate details | GET | /mandates/{id} |
| Download a mandate | GET | /mandates/{id} |
| Update a mandate | PUT | /mandates/{id} |
| Delete a mandate | DELETE | /mandates/{id} |
Replace {id} by the identifier of the mandate that you would like to use.
The method
Each resource is accessible via a specific method. This method reflects the action that you would like to perform (see table below).
- GET This request is used for obtaining a resource via the server.
- POST This request is used for creating a new resource.
- PUT This request is used for updating a resource.
- DELETE This request is used for deleting a resource.
The headers
The HTTP headers are key-value pairs separated by “:”.
They are used for transmitting authentication details and information about the request contents.
The headers used in this API are described in the chapter titled Authentication.
The data (or “body”)
The data (also referred to as “body” or “message”) contains the information that you want to pass to the server. It is used only in the POST and PUT requests.
Both in requests and responses, the data is transmitted in JSON (Javascript Object Notation) format.
In this format, each property and value is enclosed in double quotes:
{
"property1": “value1",
"property2": “value2"
}