...

1. Send a /wiki/spaces/DEV/pages/2549350440 to our detailed technical documents to your developers/software provider and they can confirm if/how your system could process the APIs.

2. Determine what data you are interested in processing into your system.

3. Sign up for an API Key so you can test with the API. See our user-guide here, Creating an API account

4. Once you have signed up for the API you can obtain an API Key and select a Product type - FULL Access or Trial. We recommend starting with Trail while testing and the product type can be updated once you are ready to go live.

5. Once you have determined what data you want and your developers have read the documentation then PortConnect is available to answer any process or technical questions you might have. Send an email to info@portconnect.co.nz to get started.

As a software provider, can I apply for multiple API keys for my individual customers?

Yes. PortConnect bills based on the API key used to access the APIs. Software providers have the option to use a single API key and receive the bill related to all their customs or they can use multiple API keys and billing will be sent directly to the individual companies.

Are API keys associated with an organisation in PortConnect?

API keys do not need to be linked directly to a Trading Party in PortConnect but in the Container Visit Event API the Express Pin type events can only be sent to the party that obtained the Express PINs so the API key must be linked to receive the events. The linking will be done by PortConnect staff.