Suppliers Integration with Scalepoints ClaimShop

Introduction

To meet the future requirements of handling products and aligning with Scalepoint's architecture, we have developed this new way of integrating with Scalepoint.

Functionality is based on events and REST API. This solution enables us to inform our suppliers and let our suppliers update us on e.g. stock, delivery, etc. As a Supplier, you could integrate with Scalepoint for receiving orders and updated order status and also be able to publish order related information via events.

Key benefits:

1. Standard solution towards our supplier integrations
2. Flexible to extend in future
3. Suppliers could enrich Scalepoint with more information
4. Easy to track the order status with rich data given by the Supplier
5. We will have a good data flow of information between scalepoint systems and supplier systems
6. We will provide a standard solution using our Events API and web-hooks mechanism
7. We provide Scalepoint's standard security mechanism (Oauth 2.0). Information is secured via Industry Standards
8. Fast time-to-market - Solution is based on event based integrations that means systems will be lossely coupled, so upgrading of systems or new changes could be introduced quickly
9. Low cost of development and maintenance - changes could be developed with out depending on each other, changes can be introduced on their own phase. No need to test the whole application on both ends for simple changes.
10. **Solution is based on events ** - This way information is freely flown between two systems.
11. Information is available via our REST Apis - Customer can access the settlement information any given time.

How does solution works

This solution includes a ORDER-CREATED event and Order Data API.

Every time when ClaimShop receives the order from shop, ecc publishes a ORDER-CREATED event to event-api. Event Api publishes the event to the defined suppliers web-hooks service. Supplier uses Order Data API to fetch all the details about the specific order by using the Order Token received part of the ORDER-CREATED event.

For example, when ClaimShop publishes an order the ORDER-CREATED event looks like below

{
  "eventType": "order_created",
  "payloadVersion": "1.0.0",
  "correlationId": "8418F893-02AF-43AF-802B-F7F71C243969",
  "timestamp": "2018-12-27T08:46:36+0200",
  "case": {
    "uuid": "91c034af-a24f-42e7-81cb-a293d466f445",
    "number": "CH60158270",
    "externalClaimId": "",
    "token": "c.8418F893-02AF-43AF-802B-F7F71C243969",
    "caseType": "contentClaim"
  },
  "orderToken": "BC6270D7-B0FB-434F-BF83-93E361C335CD"
}

As a supplier you use the orderToken in order to get the full details about the order using Order Data API. For example in this case the URL looks like below

https://www.scalepoint.com/api/Orders?ExternalId=BC6270D7-B0FB-434F-BF83-93E361C335CD

** High level architecture diagram of the solution: **

Supplier Integration Sequence Diagram

How to Integrate:

• Please refer to the documentation about details of order created event.
• Please refer to the documentation about details of Order Data REST API.
• Please refer to the documentation on how Scalepoint publishes events to suppliers and how we handle error scenarios are clearly described.
• Once you understood the documentation, as a supplier you need to provide a web-hooks endpoint where scalepoint could publish ORDER-CREATED events.
• Once you are able to receive events then you should start accessing our Order Data REST API to fetch more details about the specific order.

Systems Involved in this solution:

• Supplier Back-end
• Authorization Server
• Event API - Webhooks
• Order Data REST API

Supplier Backend: Supplier backend system which could be able to integrate with Scalepoint backend systems

Authorization Server: Please refer to the documentation about details of authentication process.

Event API: Please refer to the documentation about details of event api and how to receive events using webhooks mechanism

Order Data REST API: Please refer to the documentation on how order data REST API works.

Go-live Checklist for Customers

1. Production ready web-hooks service to be able to receive events from Event API
2. In case of using the IP whitelist solution, add scalepoint public IP address to firewall.