Skip to main content

Developer Documentation

⚠️ Future Content: The detailed SDK documentation and community resources below will be provided in future documentation updates. Advanced developer tooling and comprehensive integration guides are being developed based on the platform's core architecture.

Welcome to the developer's space for exploring Filedgr's Data Attestation Platform. Here you'll find everything you need to build, integrate, and extend with Filedgr's APIs and SDKs.

Our Mission​

Empower organizations to own, manage and benefit from their data safely.

👉 Check out What is Filedgr & Why it matters to learn more about our mission and business context.

What is the Data Attestation Platform?​

The Filedgr Data Attestation Platform is an enterprise-grade framework to turn files, assets, and processes into verifiable digital records.

You can use the platform in two ways:

  • Web Interface → manage templates, vaults, and digital twins without writing code
  • APIs & SDKs → integrate attestation, verification, and secure data sharing directly into your own systems and workflows

The platform is enterprise-ready and compliant with major regulations like GDPR, HIPAA, and CSRD.

Core Developer Features​

With Filedgr, you can build:

  • Templates → Define structure, validation rules, and compliance logic
  • Vaults → Secure, NFT-based containers for your data
  • Digital Twins → Blockchain-attested replicas of assets, with full history and audit trails
  • Data Streams → Real-time updates from IoT, financial, or operational systems
  • Verification Proofs → Cryptographic attestations, timestamps, and shareable audit links

Developer Experience​

Filedgr supports both custodial and non-custodial usage patterns:

Managed Wallets (Custodial)​

Every developer account comes with a managed wallet for easy onboarding. No private key handling required.

External Wallets (Non-Custodial)​

Advanced users can connect their own wallets and sign transactions directly. Ideal for production-grade integrations where maximum control and decentralization are required.

Integration Capabilities​

Filedgr is designed for real-world integrations:

  • Authentication & Access Control → Secure with API keys, OAuth, and fine-grained roles
  • Automated Compliance → Generate immutable audit trails and reports on demand
  • Multi-Chain Flexibility → Support for Polygon, Ethereum, XRPL, and other networks
  • Integration-First Design → REST APIs, webhooks, and SDKs for multiple languages
  • Plug into workflows → ERP, CRM, supply chain, oracles, and no-code platforms

Quick Start Options​

🚀 5-Minute Quickstart

Get up and running with your first API call in under 5 minutes.

Start Building

🔑 Authentication

Learn about API keys, access tokens, and secure authentication patterns.

Setup Auth

📚 API Reference

Complete documentation for all endpoints, parameters, and responses.

Browse APIs

📦 SDKs

Pre-built libraries for JavaScript, Python, Go, and more coming soon.

Get SDKs

Platform Architecture​

REST APIs​

Full platform functionality accessible via HTTP requests:

  • Create and manage vaults programmatically
  • Upload and verify data through API calls
  • Control permissions for users and applications
  • Generate verification proofs for third parties
  • Monitor activity with detailed audit logs

Webhooks​

Real-time notifications for important events:

  • Data updates in vaults and streams
  • Permission changes for access control
  • Verification completions for uploaded data
  • Compliance alerts for regulatory requirements

Smart Contract Integration​

Direct blockchain interaction for advanced use cases:

  • Custom vault logic with your own smart contracts
  • Multi-chain deployments across different networks
  • Automated workflows triggered by blockchain events
  • Integration with DeFi and other Web3 protocols

Supply Chain Transparency​

// Track product from manufacturing to delivery
const productVault = await filedgr.createVault({
  templateId: 'supply-chain-v1',
  name: 'Product Batch #12345',
  metadata: {
    manufacturer: 'Acme Corp',
    productLine: 'Electronics'
  }
});

// Add manufacturing data
await filedgr.attachData(productVault.id, {
  type: 'manufacturing-report',
  data: manufacturingData,
  timestamp: Date.now()
});

Document Verification​

// Verify important documents
const contractVault = await filedgr.createVault({
  templateId: 'legal-document-v1',
  name: 'Service Agreement - Client ABC'
});

const proof = await filedgr.verifyDocument(contractVault.id, {
  document: contractPDF,
  signedBy: ['party1@company.com', 'party2@client.com']
});

IoT Data Attestation​

// Continuous verification of sensor data
const sensorStream = await filedgr.createDataStream({
  vaultId: deviceVault.id,
  source: 'temperature-sensor-001',
  frequency: '1min'
});

// Real-time data updates
await filedgr.updateStream(sensorStream.id, {
  temperature: 23.5,
  humidity: 45.2,
  timestamp: Date.now()
});

Available SDKs​

JavaScript/TypeScript​

npm install @filedgr/sdk

Full-featured SDK with TypeScript support, ideal for:

  • Node.js backend applications
  • Browser-based applications
  • React/Vue/Angular frontends
  • Serverless functions

Python​

pip install filedgr-python

Pythonic SDK perfect for:

  • Data science applications
  • AI/ML workflows
  • Django/Flask applications
  • Automation scripts

Go​

go get github.com/filedgr/go-sdk

High-performance SDK for:

  • Microservices architectures
  • High-throughput applications
  • Cloud-native deployments
  • Kubernetes workloads

Integration Patterns​

Webhook Processing​

// Handle real-time updates
app.post('/filedgr-webhook', (req, res) => {
  const event = req.body;
  
  switch(event.type) {
    case 'vault.data_updated':
      handleDataUpdate(event.data);
      break;
    case 'vault.verification_complete':
      notifyStakeholders(event.data);
      break;
  }
  
  res.status(200).send('OK');
});

Batch Operations​

// Process multiple items efficiently  
const results = await filedgr.batchCreateVaults([
  { templateId: 'product-v1', name: 'Product A' },
  { templateId: 'product-v1', name: 'Product B' },
  { templateId: 'product-v1', name: 'Product C' }
]);

Error Handling​

try {
  const vault = await filedgr.createVault(vaultData);
  console.log('Vault created:', vault.id);
} catch (error) {
  if (error.code === 'RATE_LIMIT_EXCEEDED') {
    // Implement retry with exponential backoff
    await retryWithBackoff(() => filedgr.createVault(vaultData));
  } else {
    console.error('Vault creation failed:', error.message);
  }
}

Development Environment​

Sandbox Access​

Test your integration safely:

  • Separate test environment with full functionality
  • Test data and templates for experimentation
  • No blockchain fees for development
  • Reset capabilities to start fresh

Local Development​

Run Filedgr locally:

# Clone the development environment
git clone https://github.com/filedgr/dev-environment
cd dev-environment

# Start local services
docker-compose up -d

# Configure your application
export FILEDGR_API_URL="http://localhost:8080"
export FILEDGR_API_KEY="dev-key-123"

Community & Support​

Developer Resources​

Getting Help​

Next Steps​

Ready to start building? Choose your path:

  1. Quick Start Guide - Get your API key and make your first call
  2. Authentication Setup - Configure secure access
  3. Core Concepts - Understand templates, vaults, and digital twins
  4. API Reference - Explore all available endpoints

The power of blockchain verification, made simple for developers.