Docs

API Documentation

Version 1.0.0

DataWise Document Exchange

API v1.0.0

Authentication

Security Notice

Never expose your API key in client-side code or public repositories. Always make API calls from your backend server.

API Key Authentication

The DataWise Document Exchange API uses API key authentication. Include your API key in the Authorization header as a Bearer token for all requests.

Authorization: Bearer YOUR_API_KEY

Getting Your API Key

Create an Account
Sign up for a DataWise account if you have not already
Create an Application
Navigate to your dashboard and create a new application
Set Up Payment
Add a payment method and configure auto-recharge settings
Copy Your API Key
Your API key will be displayed in the application settings

Each application has its own unique API key. You can create multiple applications to organize different projects or environments (development, staging, production).

Request Examples

curl -X POST https://api.datawise.app/api/datawise_document_exchange \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: multipart/form-data" \
  -F "ddx_outputFormat=pdf" \
  -F "firstName=John" \
  -F "ddx_template=@template.docx"

const fs = require('fs');

const form = new FormData();
form.append('ddx_outputFormat', 'pdf');
form.append('firstName', 'John');
form.append('ddx_template', fs.createReadStream('template.docx'));

fetch('https://api.datawise.app/api/datawise_document_exchange', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY'
  },
  body: form
});

import requests

url = 'https://api.datawise.app/api/datawise_document_exchange'
headers = {
    'Authorization': 'Bearer YOUR_API_KEY'
}
files = {
    'ddx_template': open('template.docx', 'rb')
}
data = {
    'ddx_outputFormat': 'pdf',
    'firstName': 'John'
}

response = requests.post(url, headers=headers, files=files, data=data)

$curl = curl_init();

$postData = [
    'ddx_outputFormat' => 'pdf',
    'firstName' => 'John',
    'ddx_template' => new CURLFile('template.docx')
];

curl_setopt_array($curl, [
    CURLOPT_URL => 'https://api.datawise.app/api/datawise_document_exchange',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_POST => true,
    CURLOPT_POSTFIELDS => $postData,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer YOUR_API_KEY'
    ],
]);

$response = curl_exec($curl);

API Key Security

Do's

• Store API keys in environment variables
• Make API calls from backend servers

Don'ts

• Never commit keys to version control
• Don't expose keys in client-side JavaScript
• Avoid hardcoding keys in source code
• Don't share keys via email or chat

Environment Variables

Best practice: Store your API key in environment variables

.env file:

DATAWISE_API_KEY=your_api_key_here

Usage in Node.js:

require('dotenv').config();
const apiKey = process.env.DATAWISE_API_KEY;

docker-compose.yml:

services:
  app:
    environment:
      - DATAWISE_API_KEY=${DATAWISE_API_KEY}

Create secret:

kubectl create secret generic datawise-api \
  --from-literal=api-key=your_api_key_here

Use in deployment:

env:
  - name: DATAWISE_API_KEY
    valueFrom:
      secretKeyRef:
        name: datawise-api
        key: api-key

Authentication Errors

Error Code	Message	Solution
AUTH_NO_API_KEY	No API key provided	Include Authorization header with Bearer token
AUTH_INVALID_API_KEY	Invalid API key	Check your API key is correct and active
AUTH_APP_NOT_ACTIVE	Application is not active	Ensure your application is active
PAYMENT_INSUFFICIENT_FUNDS	Insufficient funds in account	Make sure your credit/debit card is valid and has funds

Need Help?

If you're having authentication issues, check your dashboard for API key status and balance, or contact our support team for assistance.