User registration API

27/03/2009

Users can be registered via API with a minimal level of detail to enable their access without logging in.

Call format

A call can be made using HTTP POST from your server to your ZetaPrints web-to-print portal.

Parameters:

  • ApiKey – see API page in your ZetaPrints account (required)
  • UserID – a GUID generated by a remote system (required)
  • Password – a string between 3 and 50 characters (required)
  • CorporateID – catalog ID to grant access to (optional)

Query string: http://[domain name]/API.aspx?page=api-user-new

Response:

  • <error /> – the user exists or one of parameters is invalid or missing
  • <ok /> – a new user was created

Example:

http://orders.example.com/API.aspx??page=api-user-new;ApiKey=612ecb11-48fd-4df7-b004-3e497919283e

<input type=”hidden” name=”Password” value=”rAnd0MstriNG” />

<input type=”hidden” name=”UserID” value=”AE091662-E482-4984-9BDF-E65FDDF55F29″ />

API usage

The most likely scenario is for your website to hold all user details and be fully responsible for all user communication.  ZetaPrints web-to-print service is used only for generating preview and output files.  RetE parameter set to 1 to show ZetaPrints in a frame or a separate window.

Your server would make registration calls to ZetaPrints when new users are created and retain UserID and Password for future use.

ZetaPrints UI

ZetaPrints web-to-print software treats a user registered via this API as incomplete registration and offers to complete registration. However, using RetE=1 while referring the user to ZetaPrints instructs the system to hide the top and left hand side menu, so the user won’t see the reminders.

ZetaPrints web-to-print software cannot send any emails to such users because the email address is not known.

The user may still access your web-to-print portal directly and complete the registration.


See also: