This section describes some basic properties and procedures of the interface. We assume that you have a general understanding of how to use Web services and JSON.

This documentation refers to the embedded-ebis plugin from version 1.8.25 (easy archive 6.2) and 7.0.2 (easy archive 7).

In easy archive 6.2, content web service is, by default, available at

https://localhost:9090/api/content

Whereas in easy archive 7, this Web service runs, by default, via HTTPS and Port 9443:

https://localhost:9443/api/content

Security

It is recommended that you target the interface only via HTTPS. Due to the HTTP basic authentication method, the credentials are, as it were, transferred unencrypted. To set up HTTPS, see Configuring the embedded-webserver-jetty plug-in.

Error returns

Basically, the HTTP status code is set for an initial rough division with a faulty execution of the request. The problems that may occur here are described in the API reference; however there is a general pattern:

•  Code 400 (Bad request): Error in the input data or non-performable request.
•  Code 401: Missing authentication.
•  Code 403: Insufficient permissions for the request.
•  Code 404: The resource does not exist.
•  Code 405: The HTTP method used cannot be used.
•  Code 406: The transmitted data with POST or PUT are not of a matching Content type.
•  Code 409: Between GET and PUT of a resource, this has already been modified on the server through another process or call.
•  Code 500: Internal server error; this usually occurs only with programming errors in the server.

In addition to the HTTP error codes, a JSON structure like the one below is returned:

message is used to return the error message, while warnings may contain a list of additional warnings.