SAP: SMS connector on BTP Integration Suite
Creating a custom Retarus SMS connector with SAP BTP Integration Suite enhances SMS messaging automation and simplification. This connector integrates seamlessly within the SAP environment, ensuring data security, regulatory compliance, and real-time SMS data synchronization.
Developer: Custom Connector
Category: Tutorial
Prerequisites
SAP BTP (Business Technology Platform) and Integration Suite:
Enabled capabilities: Open Connectors, Cloud Integration (optional), API Management (optional).
Cloud tenant ID and password (also called a cloud secret).
Basic authentication must be set up to gain access to an active instance of the integration solution. The necessary information can be found in the curl instructions of the API documentation.
A unique SAP Cloud URL within the operational service instance provides access to the service instance.
Retarus SMS-for-Applications account and login ID (username and password).
Fill out the contact form or talk to a Retarus representative to get a trial account.
Multiple login IDs can be created within the same customer tenant to allow for different processing configurations.
Importing the API specification
The required actions are described “from scratch,” but SAP may provide pre-built packages or artifacts that include the connector and the integration flow for download.
Open the SAP Integration Suite Home page and select Open Connectors.
Navigate to the Connectors page, and select Build New Connector.
→ Click Import.
→ Select Swagger.
→ Specify the path to the OpenAPI specification file:
Navigate to the Import from URL field.
Select Continue Import.
→ Choose resources for the connector:
Use this option to hide ‘out of scope’ REST resources from SAP users, without modifying the service itself.
In this example, mark the Select All Resources checkbox.
Select Import in the lower right corner.
Enter the Base URL: https://sms4a.retarus.com/
Choose basic as the authentication method. This authentication requires the username (also known as login ID) and password.
Select Save.
The username and password are not necessary in this step. These details can be entered while starting a running instance of the connector, as described in the following section.
The connector can be enhanced in the Information tab by giving it a meaningful name, such as the raw service name and protocol, and adding a brief description of the service.
Starting a connector instance
The new connector needs to be turned into a working instance before it can be made available via an SAP-native cloud URL with REST resource suffixes.
→ On the Connectors page, select Create Instance to open the connector search widget.
→ Search for the previously created connector.
→ In the instance initialization dialog, enter the following information:
The name of the currently running instance that will be displayed in the instance overview later.
The Retarus SMS login ID credentials (username and password).
Select Create Instance.
Testing the connector instance
→ Select Test in the API docs to test the connector instance.
The blue box indicates the currently selected and authenticated instance.
→ Navigate to the GET /rest/v1/version resource, select Try it out, and then Execute.
The response payload should contain a successful response (code 200) along with some service version information.
→ Navigate to the POST /rest/v1/jobs resource, and select Try it out.
→ In the Edit Value field, enter and modify a simple job, including the appropriate mobile phone number, and select Execute.
{"messages":[{"text": "Hello World!", "recipients":[{"dst": "+49160xxxxxxxxxx"}]}]}
If the operation succeeds, an OK/200 response and the Retarus SMS job ID are displayed. Consequently, an SMS is sent to the specified phone number.
The connector is now up and running and can be used by other integration consumers.
All SMS features described in the API Docs for Retarus SMS (REST) can be found in the Retarus documentation in the EAS portal.
If any concerns or issues arise, contact Retarus support and request assistance from an integration expert.
To incorporate Retarus Enterprise Cloud products, such as SMS-for-Applications (REST API), into the SAP BTP tenant environment, two key components are required:
Access to the Retarus SMS API
To gain access, create and instantiate a custom connector for Retarus SMS. As a result, an SAP-native cloud URL will be provisioned, enabling access to Retarus SMS directly from within SAP.Integration of web service methods
The main purpose of the integration is to transform SAP content into the required REST API request headers, properties, and JSON payload for job transmission.
To become familiar with the Retarus SMS-for-Applications REST API, launch the Swagger UI and run some tests (the login ID, username, and password for Retarus SMS are required).