Skip to main content

Integration

Your own developers can connect an accounting or ERP system to the WMS. Before they write any code, an administrator sets up the WMS side in the desktop Client app, under Administration. This section walks through that setup. At the end you hold everything your code needs for its first request.

How the pieces fit together​

An integration is made of two things you create in the Client:

  • A technical user — an account for a program rather than a person. It signs in with a token instead of a password, and it can only reach the integration endpoints, nothing else in the WMS. Like any user, it gets its access by being a member of an access group — see Access rights.
  • An external system — the record of the connected system itself. It points to its technical user and says what that system is allowed to do: its capabilities, how duplicates and conflicting changes are handled, and which warehouses it may work with.

The external system is linked to the technical user, not to a particular token. When you issue a new token for the technical user, the external system keeps working with the new one.

The reference pages explain the choices you make on the external system: Integration capabilities, Deduplication modes, Ownership conflict policies. Token states are listed in Technical token statuses.

Order of setup​

The whole walkthrough is on one page: Setting up an integration. Each step below links to its own page.

  1. Create the technical user. Give it a name and a code, and enable it.
  2. Give it access. Add it to an access group, the same way as for a person.
  3. Issue a token. The raw token is shown only once, so copy it straight away. A technical user has one active token at a time: issuing a new one revokes the current one, so whatever still uses the old token can no longer sign in (a session it already had ends within a few minutes).
  4. Register the external system. Choose its code and name, link the technical user, and set its capabilities and behaviour settings. The code cannot be changed after the system is created.
  5. Set the warehouse scope. Either allow all warehouses, or list the ones the system may work with. With global access off and an empty list, the system has access to no warehouse.
  6. Hand off to the developer. See the checklist below.

Hand-off checklist​

Give the developer these three things:

  • The company code — what the Client sign-in screen shows as the Tenant field (in Ukrainian, Компанія). It tells the WMS which company the requests belong to.
  • The raw token — shown once when it is issued. If it is lost, issue a new one (this revokes the previous one).
  • The external system code — the code you chose when registering the system.

Licence limit​

Technical users use up the technical seats of your licence. When all seats are taken, switching on one more technical user fails, and an integration can be refused at sign-in if the licence's technical seats are exceeded. To see how many technical seats your company has and how many are used, open License in the Client, under Administration.

For the developer​

With these three things the developer connects your system through the integration API:

What to do about ownership and deduplication conflicts is covered in Conflicts.