Guidelines

Service gateway and route configuration

How to create and configure a Gateway service and route.

README & Guidelines / As an API Producer / Service gateway and route configuration

For V1 architecture (deprecated 30/09/2025)

1. Connect to Kong Admin Portal

  • Go to Admin Portal.

2. Create a new Gateway service:

  • Go to the Gateway Manager section of the left-hand menu.
  • Click on the name of the control plane (= gateway) that corresponds to your environment:
RegionDEVTSTUATINTPROD
North EuropeAEnDevGtw-CoreSharedAEnTstGtw-CoreSharedAEnUatGtw-CoreSharedAEnIntGtw-CoreSharedAEnPrdGtw-CoreShared
East2 USAUe2DevGtw-CoreSharedAUe2TstGtw-CoreSharedAUe2UatGtw-CoreSharedAUe2IntGtw-CoreSharedAUe2PrdGtw-CoreShared
  • Go to the "Gateway Services" sub-section in the left-hand menu.
  • Click on the "New Gateway Service" button on the right.
  • Enter the name of the service, which must correspond to the categories of business objects you manipulate in the API.
    • Template type: scor-businessobjectcategoryname.
    • For example, scor-reference.
    • For your information, SAIL stands for SCOR Abstraction & Integration Layer. This means we need to be system agnostic, which should not appear in the service name.
  • Add relevant tags, such as scor, the name of the business object, the system.
  • Enter the URL of your backend, for example, http://your-backend-url.azure.scor.com.

3. Add a route:

  • Once the Gateway service has been created, access the Routes section (horizontal menu) and click on "New Route".
  • Enter the route name, for example, using the nomenclature starting with scor- followed by the object category, and if you have a lower level, you can specify the object type.
    • For example, scor-reference-treaty.
  • Set the route path, for example, /scor-reference-treaty-presentation.
  • Make sure the "Strip Path" option is enabled to remove the route prefix before redirecting to the backend.
  • Save the route.

For V2 architecture: all managed by CI/CD (contact Paul Jouet).