Skip to main content

Configure API Connection

Before ION can communicate with Vince Platform, you need to register the Vince Platform API inside Infor ION API (on-premise) or API Gateway (multi-tenant). This tells ION where Vince Platform lives and how to authenticate with it.


Prerequisites​

  • The Vince Platform OpenAPI/Swagger file — download it here
  • A Vince Platform API Client ID and Client Secret, configured in Vince Platform under Administration → Access Management → API-Clients

Step-by-step guide​

  1. In Infor OS, open Infor ION API (on-premise) or API Gateway (multi-tenant).

  2. Go to Available APIs and click ➕ Add to add a new API, then select Create New.

  3. Fill in the application details:

    • Application Name — a recognisable name for Vince Platform
    • API Context — the context path for the API
    • Suite Name and Description
    • Select a Suite Icon
  4. Add an endpoint by clicking ➕ and set the Vince Platform endpoint URL:

    • Production: https://api.vince.live
    • Staging/demo: https://api.staging.vincelive.dev/live
  5. Set the Proxy Context — this determines the internal ION API Gateway path to the endpoint. We recommend using api.

  6. Set Proxy Security to OAuth 2.0.

  7. Set Target Endpoint Security / Authentication Type to OAuth 2.0.

  8. Set the Token Endpoint using the following URL, replacing {tenantId} with your Tenant ID (found in Vince Platform under Administration → Company Management → Information):

    https://{tenantId}.auth.eu-central-1.amazoncognito.com/oauth2/token
  9. Set Grant Type to Client Credentials.

  10. Enter your Client ID and Client Secret from Vince Platform.

  11. Click the Save icon at the top.

  12. Go to the Documentation tab and click ➕ to upload the OpenAPI/Swagger file:

    • Name is not important
    • Type must be set to Swagger

    Once uploaded, the full list of Vince Platform API transactions will appear in the Documentation tab.


Next step​

Continue to Configure Service Account.