HomeInterfacesRecipesChangelogFAQ
Log In
Interfaces
  1. Summary

Migration Guide(V2)

Why update the interface?
The new interface, although very similar to the existing interface in terms of the API, uses a completely new technology stack. This technology stack gives us the following benefits:

  • No setup of IIS. New interface has built-in webserver.
  • No AutoStore Interface Service and AutoStore Interface Http. Just one module, AutoStore Interface. This makes setup much easier.
  • Faster request handling.
  • Better logging and error handling.
  • Easier configuration.
  • Easier installation.
  • New API documentation.

With the launch of the new interface, the old interface becomes deprecated. All future updates to the API will only happen in the new interface.

Breaking changes
The new interface contains some very minor breaking changes:

  • Url endpoints are changed from ASInterfaceHttp/BinInterface.aspx and ASInterfaceHttp/AutoStoreHttpInterface.aspx to api/v2/bin and api/v2/task.
  • Port is changed to 44000 from 80/433.
  • Log Publisher port is changed to 44001
  • Only UTC ISO8601 timestamps are accepted for timestamp inputs, e.g. requested_time (the old interface accepted ISO8601 timestamps but also a wider range of timestamps too)._ i.e. 2024-12-25T12:00:00Z
  • Wrapping XML inside many parent nodes. In the old interface the XML parser would accept an arbitrary amount of parent nodes inside the node in the XML. One could do <my_node><my_other_node><port_id>4</port_id></my_node></my_other_node> on openbin and it would be accepted. This is not accepted in Interface v2. This is particularily relevant for the add_task endpoint, where it has been common to wrap the task inside a node.
  • port_id 0 is not allowed anymore (was erroneously accepted in FusionPort related endpoints).

Running Interface V1 and V2 simultaneously
This should NOT be done. Use one of the interfaces. If you install V2, uninstall V1. Using both at the same time can lead to state mismatch and race conditions.

How to migrate to the new Interface
Migration to the new interface likely requires updating the WMS/WES. The update of the two needs to be coordinated. This is the most tricky part when updating to the new interface.

The changes/migration should be verified with the WMS SDK simulation before deploying to production

AutoStore recommends the following migration process:

  1. Install the new Interface.
  2. Deploy a new WMS/WES that interface the new Interface (updated URLs etc) and not the old.
  3. Verify that it works
  • If NOT, downgrade the WMS/WES so it uses the old interface again.
  • If works, UNINSTALL the old Interface by uninstalling the application and remove the corresponding IIS.

Future plans for the Interface
All new features and improvements will only be applied to the new interface, NOT the old interface. The old interface will only receive vital security fixes for a year.

With the new interface, we have introduced versioning in the api endpints (api/v2). This lets us more easily perform more major breaking changes to the API in the future. If/when this happens, we will of course let you know in due time. Having versioning explicitly in the endpoint makes it easier for us to be backwards compatible and ease the transition to new APIs.

❗️

Interface V1 will be supported for vital security and compatibility fixes until March 2026. New feature development has moved to interface V2.

FAQ
Q: What is the name of the new exe?

The new exe is called “AutoStore.Interface.exe”.

Q: Where can I find the config file?

appsettings.json in C:/ProgramData/AutoStore/Interface (or Supervisor if running through AutoStore package manager).

Q: Where are the logs located?

C:/ProgramData/AutoStore/Interface, unless manually changed in config.

Q: Is there a hostlog?

Yes, but it has been renamed to request log. Found with logs.

Q: What is the port?

44000

Q: What is the url?

api/v2/task for task interface and api/v2/bin for bin interface.

Q: What is the full URL?

http://<server>:44000/api/v2/taskor http://<server>:44000/api/v2/bin

Q: Can I run both Interfaces simultaneously?

We advise you to NOT do this, even though it is technically possible.

Q: For how long will the old interface be supported?

No new features or improvements to old interface. Only vital security fixes for 1 year.

Q: How should I migrate to the new interface?

Follow the migration guide above.

Updated 2 months ago