Create or Edit an API Connection | Vantage CX - 1.4 - Creating or Editing an API Connection - Vantage Customer Experience

Vantage Customer Experience User Guide

Product
Vantage Customer Experience
Release Number
1.4
Release Date
June 2021
Content Type
User Guide
Publication ID
B035-3800-099K
Language
English (United States)
  1. Select "" > Configuration > Connections.
  2. Choose one of the following options:
    Option Action
    Create new Select Create New.
    Edit existing Either select the connection or select "" > Edit.
  3. On the Connection details page, enter a unique Connection name and an optional Description.
  4. On the Connection type page, select API then enter the Server URL.
    You cannot change the Connection type after saving the connection.
  5. On the Authentication page, select Basic or Token.
    1. For Basic, enter the User and Password of the API client for this connection.
    2. For Token, enter a valid access token for the connection.

    The password and token are encrypted and cannot be edited after saving the connection. To change the password or token, select Reset and enter a new password or token.

  6. On the Endpoint page, enter the Endpoint path and select the Request type for the endpoint. By default, a leading slash (/) is assumed for the Endpoint path.
    You can add static and dynamic parameters. To use dynamic parameters in the path, use {parameter} to add the variable name that you defined in the dynamic parameters table of the data integration.

    For example:

    /api/v3/${dynamicParameter1}/staticParmater2?staticQueryParameter1=value1

    See Dynamic and Static Parameters.
  7. [Optional] In the Headers area, select + to add header name and value pairs to define the data structure. You can duplicate or delete existing headers.
  8. Select Save Connection.