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:


Shipper has a basic REST API for a some functions:


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:
  5. User wants to look up inventory for SKU t2
  6. System calls the shipper service to get the data: