How to configure a supplier for Web Services

This article is aimed at Supply Chain Managers wishing to allow suppliers on the Claritum System access to the Web Services in order to perform such tasks as automating the receipt of Supplier Purchase Orders, downloading file attachments etc.

In order for a supplier to gain access, there must be at least one Supplier User registered for the supplier on the system. The supplier will need an 'API UID' and a password. These are both set for the Supplier User.

  1. Go to Suppliers -> View Suppliers to get the list of suppliers.
  2. Find the supplier and click to edit the supplier details.
  3. Click the Users tab.
  4. Click the Edit button on the appropriate Supplier User (or create one if no user exists).
  5. Make up an 'API UID' and enter it into the External ID field. Typically this might a randomly generated 5-digit number or it could be a combination of letters and numbers, anything that can be communicated to the supplier for them to use as their API UID.
    Examples: '57211', '987654', '127uu55xx972'
  6. If this is a new Supplier User then don't forget to also set the password. Good passwords use a combination of upper and lower-case characters, letters and numbers, E.g. 'iAm8PassW0rd'
Once you have set this you can then inform the supplier of their API UID and Password:

Dear Bob,

Your Web Services access is now available.

Your API UID is 987654
Your Password is iAm8PassW0rd