This feature of the console lets Data Users contact Data Providers with the question to start sharing data for a specific API. Next to asking permission to use data, this feature also enables the two parties to agree on the Data Fee for an API.
This feature is only available to the administrators of the console, regular users will not be able to go through this process. Initially this feature is only available for the Import Consignment API, this will be rolled out for other API's in the future.
Accessing the Handshake Feature
Go to the NxtPort Console and login to your account. Go to the 'Data Provider' tab and select the Import Consignment API, next you click the 'Data' tab.
Overview of the Data Provider Perspective
Under the data tab you will see, from left to right, the process that will be followed from the perspective of the Data Provider, each step has his own tab. When going through the process the Request will move from left to right with each step depending on the actions taken by the Data User.
Brief explanation per tab:
New data user
New Data Users for the API will be listed under this tab, if you click 'View Details' in the row of a Data User you will be able to see the details regarding this API.
When a request of a Data Provider is send, the Data Provider will be able to monitor this under this tab.
When the Data Provider does not want to share data with the Data User the request will shift to this tab.
When the Data Provider reacts to a request with a pricing proposition the request will shift to this tab.
If the Data User does not want to agree to the proposition of the Provider the declined offer will shift to this tab.
When an offer is accepted by both parties the agreements is placed under this tab.
React to a Data Request
Once a Data User sends a request the Data provider will receive an email (as illustrated below). In this email a link is attached that will redirect you to the console, beneath the link the remarks of the Data User are shown.
Go to the 'New Request' Tab and click 'Reply' next to the Data User that wants to use your data.
The fields with light grey text are fixed and cannot be edited.
Set your data fees
If you want to charge the Data User an extra fee above the NxtPort transaction fee you can insert a fee in the marked fields. In the column on the right you can see the total price (i.e. the sum of the NxtPort transaction fee and the Data Providers data fee). For the Import Consignment API you can set a price per Bill of Lading, per Container Number or both.
The Renewal of agreement is a period during which you cannot change the fees one-sided. This is a built in protection for the Data User so that they cannot be charged excessive prices when they have integrated the API.
You can add a remark for the data user. Although this remark is optional we strongly recommend to add a message wherein you can explain why you charge a certain amount.
Tip: The flow that was built for this feature is quite straightforward and does not allow for sending emails back & forth via the console. We recommend adding an email address or telephone number so the price can be negotiated parallel with the console. When an agreement is reached on pricing you can can then continue using the console.
Click 'Reply with offer' when your proposition is ready to be communicated. The Data User will receive an email with a link that will redirect him to the console, here he will be able to decide whether he wants to accept or decline your offer. Depending on his reaction the request will end up under the 'Offer declined' or 'Active' tab.
Renewal of Agreement
The renewal of agreement period is the period in which the Data Provider cannot edit his data fees. This function is a built-in protection for the Data User as he can be sure that is this period the prices can't be changed without their consent.
The period start once the agreement is reached. If no actions are made by any of the parties the period is tacitly extended for the initially agreed upon period.
None of the parties receive a reminder when the end of the period approaches. With future releases of this feature both parties will receive an email so they can renegotiate the pricing before the period ends.
During the Renewal of Agreement period pricing can be changed by the NxtPort support when both parties reach a mutual agreement.
Personal Contact Information
It is desirable to always attach personal contact information to your message/remark so that the Data User can contact you to reach an agreement.