Doxument REST API Console

Use this tool to test-drive Doxument REST API without writing a single line of code. To get started watch this quick video tutorial or see Console Help for more details.

Watch Tutorial | Console Help | Get Your API Key | Documentation   

Authentication - Custom Token

Custom token provides you with anonymous access to demo account.

  • Select "Custom Token" in Authentication drop-down menu.
  • In the popup window confirm your selection by clicking 'OK' button.
  • You are ready to make requests against the demo account.
NOTE: Please note that the information in the demo account is visible to other guest users such as yourself.

Authentication - Basic Auth

To connect to your private Doxument account please follow these steps:

  • Select "Basic Auth" in Authentication drop-down menu.
  • Enter your Doxument API Key and Token into "Username" and "Password" fields correspondingly.
  • Click 'OK' button.
  • You are ready to make the requests against your private account.

Basic Usage

  • 'Method' menu contains a list of available API methods. Click arrow pointing down to expand the list.
  • Hover your mouse over each API method to see a tooltip. Click a blue icon to read the full documentation.
  • Select a method you want to execute, e.g. "GET /docs.json" - lists first 10 documents.
  • Click "Send" button (the orange one) to execute the request.

Upload Document

  • Expand left menu with "API Methods".
  • Select "POST /docs.json".
  • Switch to "Body" tab".
  • Scroll down and select a document from your device.
  • Click "Send" button to upload it.

Convert Document

  • Copy value of "X-Doxument-Id" header from previous response.
  • Expand left menu with "API Methods".
  • Select "Convert /docs/{id}.{format}" from the list
  • Switch to "Template" tab and paste document id into "id" field.
  • In the "format" field specify format to convert to, e.g. "txt".
  • Click "Send" button to convert it.

Download Document

  • Copy new value of "X-Doxument-Id" header from previous response.
  • Expand left menu with "API Methods".
  • Select "Download /docs/{id}" from the list
  • Switch to "Template" tab and paste new document id into "id" field.
  • Click "Send" button to download it.
Copyright 2010-2017 - Doxument. All rights reserved. Privacy - Terms of Service - Contact Us