Setup

To setup or initialize Logistix, you need to have access to these details:

  1. Subdomain: The URL of your Logistix site. It looks like this [YOUR_BUSINESS].logistix.africa. Your subdomain is the "YOUR_BUSINESS" portion of the URL. For instance, if your business site is example.logistix.africa, your subdomain is "example".

  2. appId: You can obtain this data by visiting the dashboard of your Logistix site and navigating to Preferences > Developer page. You will find your appId under the field with the label "appId".

  3. appKey: You can obtain this data by visiting the dashboard of your Logistix site and navigating to Preferences > Developer page. You will find your appKey under the field with the label "appKey".

Please be aware that your appId and appKey are highly confidential information and must never be shared with a third party.

 <body>
     ...
     <script>
         let token;
         window.onload = async function () {
            token = await Logistix.initialize({
                subdomain: 'YOUR_SUBDOMAIN',
                appId: 'YOUR_APP_ID_HERE',
                appKey: 'YOUR_APP_KEY_HERE',
                options: { ... }
            });
        }
     </script>
 </body>

At the point of initialization, we generate a token which you must provide in the options argument of all subsequent API method calls.

PreviousInstallationNextParcel

Last updated