SupportDocumentationIntegration & API Guide
Development
30 min read
Last updated: 2024-01-15

Integration & API Guide

Integration Overview

Ademero provides comprehensive integration capabilities to connect with your existing business systems.

Integration Methods

Multiple ways to integrate with Ademero:

REST API

Full-featured REST API for programmatic access to all Ademero functionality.

Authentication

API authentication using OAuth 2.0 or API keys.

// Example authentication header
curl -X GET https://api.ademero.com/v2/documents \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \-H "Content-Type: application/json"

Base URL and Versioning

API endpoint: https://api.ademero.com/v2/

VersionStatusBase URL
v2Currenthttps://api.ademero.com/v2/
v1Deprecatedhttps://api.ademero.com/v1/

Common Endpoints

Key API endpoints for document management:

// Document operations
GET    /documents              // List documents
POST   /documents              // Upload document
GET    /documents/{id}         // Get document details
PUT    /documents/{id}         // Update document
DELETE /documents/{id}         // Delete document

// Folder operations
GET    /folders                // List folders
POST   /folders                // Create folder
GET    /folders/{id}/contents  // List folder contents

// Workflow operations
GET    /workflows              // List workflows
POST   /workflows/{id}/start   // Start workflow
GET    /tasks                  // Get user tasks
POST   /tasks/{id}/complete    // Complete task

// User management
GET    /users                  // List users
POST   /users                  // Create user
GET    /users/{id}             // Get user details
PUT    /users/{id}/permissions // Update permissions

API Examples

Common integration scenarios with code examples.

Document Upload

Upload a document with metadata:

// Node.js example
const FormData = require('form-data');
const fs = require('fs');
const axios = require('axios');

const form = new FormData();
form.append('file', fs.createReadStream('invoice.pdf'));
form.append('metadata', JSON.stringify({
  documentType: 'Invoice',
  vendor: 'Acme Corp',
  amount: 1500.00,
  dueDate: '2024-02-15'
}));

const response = await axios.post(
  'https://api.ademero.com/v2/documents',
  form,
  {
    headers: {
      ...form.getHeaders(),
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

Search Documents

Search for documents using metadata:

// Python example
import requests

params = {
  'query': 'invoice',
  'documentType': 'Invoice',
  'dateFrom': '2024-01-01',
  'dateTo': '2024-01-31',
  'vendor': 'Acme Corp'
}

response = requests.get(
  'https://api.ademero.com/v2/documents/search',
  params=params,
  headers={'Authorization': 'Bearer YOUR_TOKEN'}
)

documents = response.json()['results']

Start Workflow

Trigger a workflow programmatically:

// C# example
using (var client = new HttpClient())
{
    client.DefaultRequestHeaders.Authorization = 
        new AuthenticationHeaderValue("Bearer", "YOUR_TOKEN");var workflowData = new
    {
        documentId = "DOC-12345",workflowId = "invoice-approval",parameters = new
        {
            urgency = "high",approver = "john.doe@company.com"}
    };
    
    var response = await client.PostAsJsonAsync(
        "https://api.ademero.com/v2/workflows/start",workflowData
    );
}

Webhooks

Real-time event notifications for system integration.

Webhook Events

Available webhook events:

Webhook Configuration

Set up webhooks in the admin panel or via API:

// Webhook payload example
{
  "event": "document.created","timestamp": "2024-01-15T10:30:45Z","data": {"documentId": "DOC-12345","name": "Invoice_2024_001.pdf","folderId": "FOLDER-789","uploadedBy": "john.doe@company.com","metadata": {"documentType": "Invoice","amount": 1500.00
    }
  }
}

Webhook Security

Verify webhook authenticity using HMAC signatures included in the X-Ademero-Signature header.

Pre-built Integrations

Native connectors for popular business applications.

Microsoft 365

Deep integration with Microsoft ecosystem:

Google Workspace

Seamless Google integration:

ERP Systems

Connect with major ERP platforms:

SystemIntegration TypeFeatures
SAPAPI + FileDocument archiving, invoice processing
OracleAPITwo-way sync, metadata mapping
NetSuiteSuiteScriptReal-time document access
QuickBooksAPIInvoice/receipt automation

SDK Libraries

Software development kits for popular programming languages.

Available SDKs

Official SDK libraries:

// Installation examples
// Node.js
npm install @ademero/sdk

// Python
pip install ademero-sdk

// Java
<dependency>
  <groupId>com.ademero</groupId>
  <artifactId>ademero-sdk</artifactId>
  <version>2.5.0</version>
</dependency>

// .NET
dotnet add package Ademero.SDK

SDK Usage Example

Initialize and use the SDK:

// JavaScript SDK example
const Ademero = require('@ademero/sdk');

const client = new Ademero({
  apiKey: 'YOUR_API_KEY',
  baseUrl: 'https://api.ademero.com/v2'
});

// Upload document
const document = await client.documents.upload({
  file: fileBuffer,
  folder: '/Finance/Invoices',
  metadata: {
    type: 'Invoice',
    vendor: 'Acme Corp'
  }
});

// Search documents
const results = await client.documents.search({
  query: 'quarterly report',
  filters: {
    dateRange: ['2024-01-01', '2024-03-31']
  }
});

File System Integration

Monitor file systems for automatic document import.

Watch Folders

Configure folders to automatically import documents with rules for metadata extraction and routing.

Network Drives

Map network drives and SMB/CIFS shares for seamless file access.

Email Integration

Process emails and attachments automatically.

Email Filing

Configure email addresses that automatically file attachments:

Rate Limits and Best Practices

API usage guidelines and limits.

Rate Limits

API rate limits by plan:

PlanRequests/HourBurst Rate
Starter1,00050/minute
Professional10,000200/minute
Enterprise100,0001,000/minute
CustomUnlimitedCustom

Best Practices

Follow these guidelines for optimal integration: