Authentication

the authentication requirements for the entire API

All TransVirtual API endpoints require valid authentication. The TransVirtual API authenticates all requests via inspection of the HTTP Authorization header attribute Authorization: 11111|QHYKGDFDSL. You will be required to populate this field for all requests.

The Authorization value is constructed with your TransVirtual Number followed by your Auth Token. Your TransVirtual number is located on every web page of the TransVirtual portal to the bottom left. Your Auth Token can be obtained within your Settings page, Tools -> Settings

The format of the Authorization value is strictly TransVirtual Number|Auth Token. Please contact our office if these values are not known.

An example request might look like:


        PUT /Api/Consignment HTTP/1.1
Host: api.transvirtual.com.au
Accept: */*
Authorization: 11111|QHYKGDFDSL
Content-Type: application/json
Content-Length: 0

and with example response:


        HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: 122

{"TransactionID":11244,"StatusCode":200,"StatusText":"OK", "Data":{...}}

Authentication

Chat Session