Editor API
Number of APIs: 17
NOTE: Many of the requests found in this collection cannot currently be run successfully. They can however be used as a reference in showing how the requests should be configured.
1. Administration - Get Health
GET {{editor_base_url}}/api/v1/health
2. Documents-Comments - Add Document Comments
POST {{editor_base_url}}/api/v1/documents/{{documentId}}/actions/addComments
NOTE: This endpoint changes the document and assumes that nothing else (like an editing session or another call to this endpoint) will be making changes to the document at the same time.*
• DO NOT call this endpoint if an end user is actively editing the document.
• DO NOT make concurrent calls to this endpoint for the same document.If you do these things, changes to the document may not be applied correctly
https://api.accusoft.com/editor/docs/#api-Documents-addComments
3. Documents-Comments - Delete Document Comments
POST {{editor_base_url}}/api/v1/documents/{{documentId}}/actions/deleteComments
4. Documents-Comments - Get Document Comments
GET {{editor_base_url}}/api/v1/documents/{{documentId}}/comments
5. Documents-Comments - Update Document Comments
POST {{editor_base_url}}/api/v1/documents/{{documentId}}/actions/updateComments
6. Documents-Text - Find and Replace Text (Beta)
POST {{editor_base_url}}/api/v1/documents/{{documentId}}/actions/findAndReplace
https://api.accusoft.com/editor/docs/#api-Documents-findAndReplace
This endpoint is intended to be used by a server-side process that has exclusive access to a document. It is typically used to prepare a document before creating a session for an end user to edit it, or to finalize a document before downloading it into your application.
Note: This endpoint changes the document and assumes that nothing else (like an editing session or another call to this endpoint) will be making changes to the document at the same time.
- DO NOT call this endpoint if an end user is actively editing the document.
- DO NOT make concurrent calls to this endpoint for the same document.
If you do these things, changes to the document may not be applied correctly.
7. Documents-Text - Get Document Text (Beta)
GET {{editor_base_url}}/api/v1/documents/{{documentId}}/text
8. Documents - Upload Document
POST {{editor_base_url}}/api/v1/documents
9. Documents - Clone Document
POST {{editor_base_url}}/api/v1/documents/{{documentId}}/actions/clone
https://api.accusoft.com/editor/docs/#api-Documents-clone
Makes a copy of a given document in its current state and returns the cloned document id.
- The clone operation may fail resulting in a 580 response code when using filesystem storage while an end user is actively editing the document.
10. Documents - Delete Document
DELETE {{editor_base_url}}/api/v1/documents/{{documentId}}
11. Documents - Download Document
GET {{editor_base_url}}/api/v1/documents/{{documentId}}
12. Sessions-Document - Download Document
GET {{editor_base_url}}/api/v1/sessions/{{sessionId}}/document
13. Sessions-Document - Download Session Document
GET {{editor_base_url}}/api/v1/sessions/{{sessionId}}/document/docx
14. Sessions - Create a Session
POST {{editor_base_url}}/api/v1/sessions
15. Sessions - Delete Session
DELETE {{editor_base_url}}/api/v1/sessions/{{sessionId}}
16. Sessions - Get Default Session Configuration
GET {{editor_base_url}}/api/v1/sessions/configurations/default
17. Sessions - Set Default Session Configuration
PUT {{editor_base_url}}/api/v1/sessions/configurations/default