Configuring APIs in the API Products Section

1. Create a new API product:

• Go to the 'API Products' section.
• Click on '+ Create an API Product'.
• Enter the product name, for example, scor-reference-treaty.
• Add a functional description of the product, for example, "Manage treaty references".

2. Add an API version:

• Once the product is created, scroll down the blue button "Actions" (top left) and choose "Add Product Version".
• Enter the version number, for example, v1.0.
• Select the production Control Plane (if it exists). Here you'll be able to get metrics between your Product API and the previously created Service Gateway. This is only necessary to do with production.
• Select the associated Gateway service, for example, scor-reference-treaty.
• Save the version.
• Upload the OpenAPI file (YAML or JSON) corresponding to this version.

For V1 architecture (deprecated 30/09/2025)

Important: before uploading the file, please add the servers field to the OpenAPI json file and list your endpoints with the SAIL URLs followed by the environment.

Below some examples. Please be cautious when copy-pasting. Align URLs with your application's non-production environments (Dev, UAT, TST, INT) and adjust the API name.

"servers": [
  {"url": "https://coreshared-uat.apim-eu.sail.azure.scor.com/scor-ref-treaty-presentation", "description": "uat"},
  {"url": "https://coreshared-int.apim-eu.sail.azure.scor.com/scor-ref-treaty-presentation", "description": "int"},
  {"url": "https://coreshared.apim-eu.sail.azure.scor.com/scor-ref-treaty-presentation", "description": "prod"}
]

For V2 architecture: contact the platform team.

3. Publish the API product:

• Go to the 'API Products > Products Versions' section.
• Scroll down the blue "Actions" button and select "Publish to Dev Portals".
• Select this portal and activate the publication (Published: On).
• Check "Also publish this version's API Product to this Portal?"
• Save.

Important Points

• Route Names: use specific route names to avoid conflicts, for example /scor-reference-treaty/detect.
• API Versions: manage API versions to allow updates without breaking existing services.
• Documentation: add documentation pages for each API version to make it easier for developers to use.