This section describes the technical specifications of the Request API v2.
The Request API is a REST API. It defines a set of web services that allow users and external systems to do POST, GET and DELETE requests. The requests and responses are sent via HTTP protocol.
More concretely, in the Request API you can do the following actions:
Create a generation request, which in turn initiates a document generation workflow.
The documents are generated based on the input XML you provide in the Create request call.
Prerequisite: The workflow must be configured during setup of Smart Documents, before you can use a Create request call. In a hosted setup, this is done for you by Connective. The workflow consists of multiple worker configurations.
Retrieve the status of specified request.
Retrieve the generated document(s).
Delete a specified request.
In case of discrepancies between examples and the description of the parameters section, the description of the parameters section prevails.
The services are plain REST based services, maintaining no state whatsoever.
The default URL is:
The response body contains a representation of the requested resource.
The request led to the creation of a resource. The created resource is in the body of the response and its location is found in the Location header.
Client Error responses
The request has not been applied because it lacks valid authentication credentials for the target resource.
The user action is not permitted.
404 Not Found
The origin server did not find a current representation of the target resource.
Server error responses
500 Internal Server Error
The server encountered an unexpected condition that prevented it from fulfilling the request.