CargoX Platform developer documentation

Contents

• 1. Introduction
  • 1.1. Who should read this guide
  • 1.2. What is the CargoX Platform
  • 1.3. The platform infrastructure
  • 1.4. Security at CargoX
  • 1.5. Getting started
• 2. About the document
  • 2.1. Disclaimer
  • 2.2. Copyright
  • 2.3. Revision trail
  • 2.4. Trademarks
  • 2.5. Contact Information
  • 2.6. Prerequisites
  • 2.7. Document conventions
• 3. Integration scenarios
  • 3.1. Upload to CargoX
  • 3.2. Third-party API access to data on the platform
  • 3.3. Login with CargoX
  • 3.4. Create Envelopes with documents
  • 3.5. Affiliate model
• 4. Authorization and authentication
  • 4.1. Introduction
  • 4.2. Obtaining an access token
• 5. API v3
  • 5.1. API Availability and versioning
  • 5.2. Endpoints
  • 5.3. Postman Collection
• 6. Adding files from external sources
  • 6.1. Uploading files directly
  • 6.2. Sending a reference to a hosted file
  • 6.3. Suggested graphics
• 7. Seamlessly logging in users
  • 7.1. How it works
  • 7.2. Example
• 8. Webhooks
  • 8.1. Parameters
  • 8.2. Example request
  • 8.3. Example response
  • 8.4. Supported events
  • 8.5. Supported actions
• 9. Automatically creating third-party client applications
  • 9.1. Introduction
  • 9.2. Authorizing API requests: creating a hash
  • 9.3. Create a client application
  • 9.4. Fetch application OAuth credentials status
• 10. Examples
  • 10.1. Fetching contacts with cURL
  • 10.2. Inviting companies to the platform with cURL
  • 10.3. Listing envelopes with cURL
  • 10.4. Signing a message with C#
  • 10.5. Signing a message with go
  • 10.6. Signing a message with JavaScript
  • 10.7. Signing a message with PHP
  • 10.8. Seal a draft and transfer an envelope with cURL
  • 10.9. Uploading documents to existing draft with cURL
  • 10.10. Uploading documents to new draft with cURL
  • 10.11. Further examples
• 11. Postman Examples
  • 11.1. Getting ready
  • 11.2. Creating Test Companies
  • 11.3. Create Envelopes and send them
• 12. Definition of terms

Indices

• Index

• Search Page