Our API provides read-only access to a user’s account via simple HTTP requests. It is intended to allow individuals or organisations to export documents as a backup or to transfer to other document management platforms.
Simul’s authentication tokens must be included as a request header in every request.
To generate an API key, please refer to the instructions here.
To test your API key, call our /users/me method to get your user account details:
/api/users/me
200 – Success
{
username: 'info@simuldocs.com',
displayname: 'Simul Documents'
}
401 – Unauthorized Invalid or non-existant X-Simul-Token
Gets all the documents a user has access to
/documents
200 – Success
[{
documentId: 'azm3wnd788800',
filename: 'An example.docx',
archived: false,
collection: 'Examples'
}]
401 – Unauthorized Invalid or non-existant X-Simul-Token
Gets all the versions associated with a document
/documents/:documentId/version
200 – Success
[{
revisionId: 'azm4wnd288802',
created: 1511454358873,
createdBy: 'info@simuldocs.com'
label: 'Revision name'
status: 'REVISION'|'MINOR'|'MAJOR'
}]
401 – Unauthorized Invalid or non-existant X-Simul-Token
Downloads the Microsoft Word document for the specified version
/versions/:revisionId/contents
200 – Success – Binary file
401 – Unauthorized – Invalid or non-existant X-Simul-Token