Skip to content

Interface ​

The two halves talk to each other over a narrow HTTPS interface. This chapter describes how they do it – for setup and for troubleshooting.

What is this for? ​

  • Set up the access.
  • Understand which data flows in which direction.
  • Recognise what happens when a request is repeated.

Interface

How to set it up ​

  1. The app creates one connector key per shop, shown only once. The app itself stores only a hash of it – if it is lost, a new one is created.
  2. The NCS-Webservice keeps address and key encrypted in the interfaces.
  3. From SAP to the app: articles, stock, customers, customer-specific prices and fulfillment notices.
  4. From the app to SAP: orders – and cancellations of orders that were already taken over.
  5. Longer tasks are accepted as a job; the webservice asks for its state later and receives a result per record: created, updated, unchanged, skipped or failed.
  6. Every writing request carries an idempotency key. If the same request arrives twice it is not executed twice – the original result is returned instead. That is the protection against a repeated run duplicating orders or articles.

Worth knowing

The connection runs outbound only, from your site. The app never calls in. For the firewall that means outbound HTTPS is enough; nothing has to be reachable from outside.

Documentation – NC-Solutions