Bidirectional IMS

Bidirectional IMS through API Gateway, application has an IMS end point:

  1. In API Gateway, create an authorized app of the Backend Service type.

    This authorized app represents the client side of the application, that is calling ION through API Gateway.

    1. During the creation, API Gateway generates a Client ID for this application. You must specify this ID in the connection point you create in step 3c.
    2. As part of the creation, you must click Download credentials. In the Download Credentials window, select Create Service Account. You do not have to associate a user, because ION does not authorize incoming requests based on user authorizations. Instead it verifies the Client ID.

      You require the downloaded credential file in step 4, where you configure the application.

  2. In API Gateway, select Available APIs > Add New API Suite and create an API Suite with these points of attention.
    1. Create a new Available app and select the ION Messaging Service v3 API suite template.
    2. By default, the API Context is set to ims. The IMS through API Gateway connection point that you will create later in ION, will reference this in the API Gateway path. Usually there is no reason to change it.
    3. Click + to add a deployment instance.
    4. On the Add deployment page, specify this information:
      Host Name
      Specify the name of the host that exposes your IMS service implementation.
      Port
      Specify the port for this IMS service implementation.
      Context
      Specify the path where your IMS service is exposed.
      Default Tenant ID
      Leave blank.
      Target endpoint security
      Choose the target endpoint security applicable for your application.
    5. Save the changes.
    6. Open the endpoints documentation. The methods that you must implement in your application are listed. You can try these methods after your application exposes them.
  3. In ION, create the IMS through API Gateway connection point, with these points of attention
    1. For the IMS Endpoint, select the product suite you created in step 2.
    2. For the Service Account, import a service account you created through User Management / Service Accounts.
    3. For the API Gateway Client Id, specify the client ID that was generated in step 1a.
  4. At the Application side, use the Client ID credentials that were created in step 1a.
    For details, see ION documentation.