API Overview | Proxtera

API Overview

AUDIENCE

This document is intended for product owners, tech specialists, and solution architects. For others, we invite you to visit us at Proxtera.com. If you haven’t please join Proxtera at Proxtera Global Platform

INTRODUCTION:

Proxtera helps B2B marketplace, service providers to help their customers Internationalise.
We provide this is service and provide simple microservices-based APIs.

NB:

  • The Proxtera partner platforms remain in full control of the user experience with their users (SMEs)

  • Proxtera does not directly interact with the SME end-users

With our APIs, we enable seamless end-to-end trade between member platforms as well as the provision and acceptance of trade-related services.

Proxtera does not interact with SMEs directly. All information is routed through the respective platforms/marketplaces allowing for the latter to independently design and maintain their proprietary User Experience (UX).

What is the Proxtera User Journey for the End User (SME) via its Platform

Platform Onboarding (1.0)
  • Platform will furnish required details to receive access to Proxtera’s User Acceptance Testing (UAT) portal

SME Onboarding (2.0)
  • Platform will ensure its SME has agreed to relevant terms and conditions.

Search (3.0)
  • Buyer can search for Proxtera products via the search bar on their marketplace, and push queries to Proxtera
  • Proxtera queries supplier platforms for matching listings and returns them to the buyer through their platform user interface (UI)
Messaging (4.0)
  • Buyer and supplier can send messages to each other via their own platforms’ UI (routed through Proxtera) to negotiate trade terms
Supplier Info Pull (4.0) [Optional]
  • When a buyer decides to create a Purchase Order (PO), Proxtera will pull updated Supplier information from Supplier platform

  • Note: This API is only required if all SME details are not shared at the search stage

Purchase Order (4.0)
  • Buyer can create a PO based on information furnished through the search results and updated as per negotiations through messaging
  • Supplier can receive PO and either accept or reject
  • Supplier can send rejection/negotiation message to buyer
Invoice Issuance and Acceptance (5.0)
  • Supplier can issue invoice
  • Buyer can accept invoice
Seller Shipping Status (5.0)
  • Supplier can submit shipping status updates
  • Buyer can receive shipping status updates
Goods Receipt Notice (GRN) (5.0)
  • Buyer can submit a GRN
  • Supplier can receive a GRN
Proxtera Protect (Escrow Services) (6.0)
  • Buyer can use escrow services to pay for goods via Proxtera’s escrow partners
Remittance Services (6.0)
  • Buyer can submit remittance advice to show proof of completion of payment
  • Supplier can receive remittance advice
Remittance Advice (6.0)
  • Buyer can submit remittance advice to show proof of completion of payment
  • Supplier can receive remittance advice
Other Services (Coming Soon) (7.0)
  • Buyer or Supplier can use their PO or Invoice to receive other relevant (and innovative) offerings through Proxtera

How to Integrate with Proxtera – Quickstart Guide

Onboard Platform

In order to join the Proxtera Network and begin accessing Proxtera APIs, your platform must first be onboarded onto our system. Proxtera will provide a URL, which will direct you to a registration form. Once approved by Proxtera, you will receive a confirmation email and be onboarded onto our platform. These steps are replicated for both our UAT and production environment.

Authentication

Client ID and secret keys are used by Proxtera to create an authentication token to authenticate your request and allow you to access our API. After your platform is onboarded onto the Proxtera Network, you can generate a client ID and API secret key on the Proxtera Portal to create an OAuth 2.0 token.

Once the platform is onboarded and authenticated, the following three steps will be conducted for the API endpoints.

Proxtera API and Integration Structure

Click on blue box below to redirect to relevant API Docs.