API's

All authentication happens via HAAL, where either an API key is passed, or a user name and password. For server apps, API keys are preferred.

Here is the HAAL API documentation:

• https://documenter.getpostman.com/view/262290/2sAYdcrXZh 

• Shipper has a REST API:

  • v1 --> https://app.swaggerhub.com/apis/HURKIN/ShipperXL/1.0

  • v2 --> https://documenter.getpostman.com/view/262290/2sAYdcrXZf

A typical flow is as follows:

1. User provides their email address to an app

2. System retrieves a list of shp databases they have access to: https://secure.hurkin.com/api/shp/user/instances?user=user@gmail.com

3. User provides their password.

4. System gets an authenticated session id:

   • The instance mnemonic chosen is part of the URL

   • Basic Authentication

   • https://secure.hurkin.com/api/shp/test/session

   • The session information contains a session id, user info, roles, feature access, etc.

5. User wants to look up inventory for SKU t2

6. System calls the shipper service to get the data:

   • The base url comes from the setting SVCURL in the Session

   • The instance mnemonic and SKU are part of the URL

   • Bearer Authentication {base64 encoded SessionId} 

   • https://api.hurkin.com/api/v1/test/inventory/sku/t2

   • Returns details inventory data for that SKU