2. About the document

2.1. Disclaimer

This document has been created by the CargoX. Its contents may be changed without prior notice. External web links are provided for informational purposes only. CargoX does not claim liability for access to and correctness of the referenced content.

2.3. Revision trail






Initial pre-revision.



Minor update, additional explanations and proofreading.



Move to the new version of the platform



Add info about simple integration.



Refactor documentation



Add the graphics for Upload to CargoX.



Added info about /apps/ endpoint.

2.4. Trademarks

CargoX, CargoX Platform, Smart B/L, and Smart L/C are trademarks of CargoX. All other trademarks are the property of their respective owners.

2.5. Contact Information

For questions and info relating this document please contact CargoX. We can be reached:

2.6. Prerequisites

This document expects the reader to:

  • Understand what CargoX Platform is and how it works.

  • Have basic JSON creating and parsing knowledge.

  • Be familiar with how HTTP works (especially forms, POSTs, and other HTTP verbs as well as URL encoding).

  • Understand the difference between different charsets and have a basic understanding of UTF-8.

  • Be familiar with the system that CargoX Platform is being integrated into.

  • Have basic knowledge of the programming language to be used for integration.

  • Understand difference between hashing and encryption and have a basic knowledge of how blockchain works, and how the transactions are secured with private / public keys;

  • Understand the OAuth workflow and keys.

Recommended knowledge:

  • Basic knowledge of SSL / TLS.

  • Linux command line tools (e.g. curl).

  • Understanding the difference in key storage methods (e.g. private key, key file, hardware wallet) for blockchain keys.

2.7. Document conventions

This manual uses several conventions to highlight certain words and phrases and draw attention to specific pieces of information. In PDF and paper editions, this manual uses typefaces drawn from the Roboto and Fira Code family of fonts.

2.7.1. Typographic conventions

The following typographic conventions are used to call attention to specific words and phrases. These conventions, and the circumstances they apply to, are as follows:


This typographic is used to highlight system input or output, file names and paths and literal commands appearing in-line.

2.7.2. Pull-quote conventions

Terminal output, configuration files and source code listings are set off visually from the surrounding text. When reasonable, the text includes syntax highlighting. An example:

  • Python

    from livereload import Server, shell
    from formic import FileSet
    import lesscpy
    import os
    MAKE_HTML = 'make html'
    server = Server()
    for filepath in FileSet(include="source/**/*.rst"):
        server.watch(filepath, shell(MAKE_HTML))
    for filepath in FileSet(include="source/**/*.md"):
        server.watch(filepath, shell(MAKE_HTML))

  • Java

    package org.example.example1;
    import javax.naming.InitialContext;
    public class ExClient {
        public static void main(String args[]) throws Exception {
            InitialContext iniCtx = new InitialContext();
            Object ref = iniCtx.lookup("EchoBean");
            EchoHome home = (EchoHome) ref;
            Echo echo = home.create();
            System.out.println("Created Echo");
            System.out.println("Echo.echo('Hello') = " + echo.echo("Hello"));

2.7.3. Notes and warnings

Finally, these visual styles are used to draw attention to information that might otherwise be overlooked.


This is an of a part of documentation you need to be very more careful when reading.


Important segments are used to draw the users' attention to more important bits of documentation.


Tips guide you towards useful part / best practices which are not officially part of the documentation.


This is an example of a note.


This is an example of a warning.


Dangerous operations and parts of documentation, such as deleting data.