Secure Trade Platform

Appearance

API Service ​

The SecureTrade platform offers its API service through a custom REST API built with Node.js and PostgreSQL, acting as a centralized gateway for all client applications to interact with the underlying smart contracts and database operations. It abstracts the complexity of blockchain interactions and database management, providing a unified, secure, and scalable interface for accessing contract data, managing platform data, and preparing transactions across the PayPledge ecosystem.

The API Service enables seamless integration for diverse applications, offering real-time access to contract states, comprehensive CRUD operations on all database schemas, transaction preparation, and protocol-compliant interactions with deployed smart contracts.

Key Responsibilities ​

  • Centralized Gateway: Serves as the main entry point for all clients like web apps, enterprise systems, enabling them to interact with smart contracts and database operations without direct blockchain integration.
  • Database Management: Provides comprehensive CRUD operations for all database schema tables, including user management, PayPledge lifecycle tracking, token operations, and platform configuration data.
  • Smart Contract Routers: Exposes dedicated API endpoints for each core smart contract (e.g., PayPledge, TradeTokenBridge), allowing clients to query contract state, fetch transaction data, and initiate protocol actions.
  • Transaction Preparation: Provides endpoints to prepare and simulate transactions, ensuring that all interactions are protocol-compliant and ready for signing and submission to the blockchain.
  • Core SDK Integration: Leverages the PayPledge Core SDK, which defines standardized protocols and methods for interacting with smart contracts, ensuring consistency and security across all API operations.
  • Real-Time Data Access: Offers up-to-date contract information, event logs, state changes, and database records, enabling clients to build responsive and data-driven applications.
  • Security and Access Control: Implements authentication, authorization, and rate limiting to protect sensitive operations and ensure only permitted clients can access or modify contract data and database records.

How It Works ​

  1. Client Request: Applications send REST requests to the API Service to fetch contract data, manage database records, prepare transactions, or listen for contract events.
  2. Request Routing: The API Service routes each request to the appropriate handler - either database operations for CRUD requests or smart contract handlers for blockchain interactions.
  3. Database Operations: For data management requests, the API Service performs CRUD operations on PostgreSQL database tables, maintaining data consistency and integrity across all platform schemas.
  4. Smart Contract Integration: For blockchain operations, the API Service uses the Core SDK to encode, decode, and validate protocol interactions with smart contracts.
  5. Transaction Preparation: For write operations, the API Service prepares the transaction payload, simulates execution if needed, and returns a ready-to-sign transaction to the client.
  6. Blockchain Interaction: Clients can sign and submit transactions directly, ensuring protocol compliance and auditability.
  7. Data Delivery: The API Service returns contract state, database records, event logs, or transaction results in a standardized, developer-friendly format.

Benefits ​

  • Developer Productivity: Simplifies integration for new applications, reducing the need for deep blockchain and database expertise.
  • Unified Data Management: Provides comprehensive CRUD operations across all database schemas, ensuring consistent data access and management.
  • Scalability: Supports high-throughput, multi-client environments with robust routing, data caching, and PostgreSQL's proven scalability.
  • Reliability: Centralized monitoring, logging, and error handling improve operational transparency and uptime for both database and blockchain operations.
  • Extensibility: New smart contracts, database schemas, and protocol features can be added to the API Service without disrupting existing clients.
  • Data Integrity: PostgreSQL's ACID compliance ensures reliable data operations and consistency across all platform operations.

The API Service is a foundational component of the SecureTrade platform, providing both database management and blockchain integration capabilities that enable a rich ecosystem of applications and services to leverage the power of programmable, collateral-backed trade finances.