TradeAware
  • Welcome to TradeAware User Guide
    • Getting Started
  • Using the TradeAware Web App
    • Upload and Analyzing Plots
    • Connect with your supply chain
    • Risk Assessment
    • Transaction Management
    • Document Management
    • Plot Upload and Analysis Trouble Shooting
    • How-to videos
  • Using the TradeAware API
    • API Access and Business Account Registration
    • Authentication
      • Rotate client secret
      • Endpoints enabled for programmatic access
    • Plot Uploading and Analysis Requests
    • Commercial network management
    • Transaction Management
    • API reference
      • Auth
      • Plots
        • Analyses of a specific Plot
        • Batch
      • Analyses
      • Attachments
      • Business invitations
      • Business connections
      • Transactions
        • Create a Transaction
        • Retrieve Transactions
          • Get a transaction by id
          • List all transactions
        • Modify an existing Transaction
          • Update a Transaction
          • Add a Transaction Component
          • Update a Transaction Component
          • Delete a Transaction Component
        • Delete a Transaction
        • Submit a Transaction
        • Retrieve DDS Data
      • Risk Assessments
        • Supplier Risk Assessments
          • Create a Supplier Risk Assessment
          • Update a Supplier Risk Assessment
          • Retrieve Supplier Risk Assessments
            • Get a supplier risk assessment by id
            • Get all supplier risk assessments
          • Retrieve the history
        • Plot Risk Assessments
          • Create a Plot Risk Assessment
          • Update a Plot Risk Assessment
          • Retrieve Plot Risk Assessments
            • Get a plot risk assessment by id
            • Get all plot risk assessments
          • Retrieve the history
      • Survey responses
      • Health
      • Version
      • Specification
  • Additional Resources
    • FAQs
    • Contact Support
    • Terms and Conditions
Powered by GitBook
On this page
  1. Using the TradeAware API

API reference

This resource is designed to provide comprehensive information on how to integrate and interact with our API. Whether you're a seasoned developer or new to API usage, this guide will help you understand the endpoints, request formats, response structures, and error handling mechanisms necessary to effectively use our services.

Key features of our API include:

  • RESTful Architecture: Adheres to REST principles for easy and intuitive interaction.

  • Authentication: Secure access through OAuth 2.0.

  • Data Formats: Supports JSON for streamlined data exchange.

  • Comprehensive Endpoints: Extensive coverage of operations to manage resources and access data.

  • Error Handling: Detailed error messages and status codes to assist in troubleshooting.

Dive into the specifics of each endpoint to start building robust and scalable applications with our API. For additional support, contact our technical support team.

PreviousTransaction ManagementNextAuth

Last updated 8 months ago