Edocr API Reference Documentation
Premium Account Status Required (update July 18, 2022)
Preqrequisites
Authentication
Responses
Document Retrieval
Get User Document Count
GET /api/v1/users/:userguid/documents/count
GET /api/v1/users/current/documents/count (user identified by API key)
Get User Document List
/api/v1/users/:userguid/documents
/api/v1/users/current/documents (user identified by API key)
Get Single Document
/api/v1/documents/:documentId
Get Document Analytics
/api/v1/documents/:documentId/analytics
Document Publishing
Publish Document
Create Document
Update Document
Update Metadata and/or URL
PUT /api/v1/documents/:documentId
Set Document Content
PUT /api/v1/documents/:documentId/source
Delete Document
Collections
Get Collections
Users
Get User
/api/v1/users/current (user identified by API key)
/api/v1/users/:userguid
/api/v1/users?email=foo@bar.com
Embedding Documents On External Websites
How To Embed Your Document
Managing Your Embedded Document
Prerequisites
Access to the API requires generation of an API key, which is only available to Premium
accounts. You can generate your key under Account Settings -> Integrations -> API
Integration.
Authentication
Authentication is performed by passing the API key, either via setting the “apikey” header in
the HTTPS request (all requests must be over HTTPS), or using the apikey query parameter.
Responses
All requests require apikey as either a query parameter or in the request header. If no API
key is provided, or if the API key provided is invalid, the request will be rejected with HTTP
status 401, with response body {"errorCode": "Unauthorized"}
If the requested item is not found, it will return HTTP status 404, with response body
{"errorCode": "NotFound"}
If a request is made for an item the requesting user does not have access to (e.g. requesting
another user's private document), the API will return HTTP status 403 with response body
{"errorCode": "Forbidden" }
If some other unexpected error occurs, the API will return a status 580, with a simil