5.3. 3rd-party API

Third party API is by platforms to access the application on behalf of the companies which are on their platform.

The follwing part of the documentation gives you additional information about interfaces available.

GET /third-party/registration-token/

POST /third-party/registration-token/

The most important method of the 3rd-party API is the method for creating a company. This method allows you to create a company by submitting the details to SmartBL. Once the company is created, it's bound to the client_id that created the company. This means that the platform can further interact or edit the company details.

The workflow is as follows:

  • Partner system posts the company details to this URL, including the redirect_url.
  • SmartBL returns a registration url, along with registration token.
  • Partner system redirects the user to the registration url.
  • The user either registers with SmartBL (if this is new user of SmartBL) or logs in (if she already has a CargoX account)
  • SmartBL links this company to the partner system
  • The user is redirected back to the redirect_url.
  • SmartBL sends the notification to the partner system that the company was created.

GET /third-party/notification-postback-url/

POST /third-party/notification-postback-url/

This endpoint enables the partner system to subscribe to changes on the SmartBL platform. A partner system can register one or more postback URLs. Each of these URL is notified of any change on the platform – for example, when a new company is created.

GET /third-party/address-book/

POST /third-party/address-book/

This method allows the partner system to manage the address books of linked companies. This enables the partner system to automatically add companies on their platform into the SmartBL address book.

GET /third-party/company/

POST /third-party/company/

This endpoint allows the partner system to manage existing companies on the platform and change their details. Only companies linked to the partner system (through client_id) may be modified.

GET /third-party/user/

POST /third-party/user/

This endpoint allows the partner system to manage users of specific companies. Users may be added, deleted or modified. Only companies linked to the partner system (through client_id) may be modified.