Introduction to the Transvirtual API

Introduction to the Transvirtual API

Introduction 

The REST API is an HTTP interface to TransVirtual. Using REST, you use standard HTTP requests to create, fetch and delete data from your TransVirtual account.
You can use any toolkit that supports HTTP to use the REST API. The REST API uses the standard HTTP headers and status codes, so that standard toolkits work as expected. In some areas, we have added functionality to HTTP (for example, headers to support authentication). In these cases, we have done our best to add the new functionality in a way that matched the style of standard HTTP usage.
To work with this API, you will need to understand the authentication requirements as every call to this API will require it. Please keep this in mind as you review the API, as it will be assumed knowledge all areas.
Currently only SSL connections are allowed in TransVirtual API endpoints. Communicating over SSL preserves user privacy by protecting information between the user and the TransVirtual API as it travels across the public internet.
You have the option to submit and consume data from the TransVirtual API in either JSON or XML format. You also have the ability to call the API with the JSONP for cross domain requirements.




Also attached here is a Postman (https://www.postman.com/) collection for your development team to work with. It has working examples on how to communicate with the API endpoints. These are variables set at the Collection level for the API key and the Customer code. You will require both of these for the postman collection to work and provide appropriate feedback.

    • Related Articles

    • Linking TransVirtual Accounts

      Linking Transvirtual accounts is easy; by linking accounts you will be able to transmit data between yourself and your agent/customer. To link Transvirtual accounts, you need to ensure that: - The customer/agent has Transvirtual. - You have their ...

    • Introduction to Quick Start Guide (QSG)

      Introduction to Quick Start Guide (QSG) Quick Start Guides (QSG) helps to complete the common tasks as describe below. 1. You can choose the relevant guides to compile a basic user manual. Great for training or ensuring your best practice is ...

    • Transvirtual Standard XML Import V1.0

      XML Import Sending XML consignment data to TransVirtual using the following format is the most efficient and cost effective option. <Consignments> <Consignment> <ConsignmentNumber>ABDEM90241Aasdasdas</ConsignmentNumber> ...

    • Transvirtual Detailed CSV Import V1.0

      This Detailed CSV import is designed for customers sending detailed consignment data, Sender, Receiver and Item information where additional information may be required. There are 2 files attached to this article, they are as follows; CSV ...

    • Transvirtual Standard POD Import (XML V1.0)

      POD Import Supplying your POD's in this format provides easy and detail format for integration. This can be accepted in FTP or Email. Advise your integration contact of your preferred method. <PODs> <PODEvent> ...