1. About the document

1.1. 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 SmartBL 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:

  • 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)

1.2. 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.

1.2.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:

Mono-spaced

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

1.2.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:

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"));
    }
}

1.2.3. Notes and warnings

Finally, we use three visual styles to draw attention to information that might otherwise be overlooked. These styles include: notes, warnings and important elements.

Note

This is an example of a note.

Warning

This is an example of a warning.

Important

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