SmartBL API integration Quickstart¶
Jul 05, 2019
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.
Copyright¶
2019 © CargoX Ltd. All rights reserved.
This document and any of its parts, including attachments, must not be reproduced, saved or treated in any other way, including electronic, electrostatic and photo-copying, using a magnetic tape or an optical medium without prior written consent from the authors. Information contained within is intended for the addressed party only and may contain confidential and/or privileged material. All ideas and suggestions described in this document are owned by the authors unless explicitly specified otherwise.
Original version of this document can be obtained from CargoX (https://developer.smartbl.io/).
Trademarks¶
CargoX, SmartBL, and SmartLC are trademarks of CargoX. All other trademarks are the property of their respective owners.
Contact Information¶
For questions and info relating this document please contact CargoX. We can be reached:
- via live chat: please open chat in the lower right corner of https://cargox.io/
- via email: write to us at info@cargox.io
Revision trail¶
Author | Ver | Date | Description |
---|---|---|---|
Bojan Čekrlić | 1.0 | 2018-12-01 | Initial pre-revision. |
Bojan Čekrlić | 1.1 | 2018-12-12 | Minor update, additional explanations and proofreading. |
Who should read this document¶
This document is intended for CargoX partners and clients, who with to integrate the CargoX's SmartBL platform into their online system. It describes the basis of integration with the system through all available interfaces. Intended audience therefore includes developers and interested parties.
Table of contents¶
- 1. About the document
- 2. Definition of terms
- 3. Introduction
- 4. Getting started
- 5. API v1 (legacy)
- 6. API v2 (future)
- 7. Examples
- 7.1. Logging in for 3rd-party systems
- 7.2. Seamlessly logging in users from 3rd-party systems
- 7.3. Logging in with a login key
- 7.4. Logging in with a username and password
- 7.5. Signing a message
- 7.6. Signing a message with C#
- 7.7. Creating a new package
- 7.8. Registering a new company
- 7.9. Topping up credits
- 7.10. Further examples