Introduction

This User Manual provides specifications of the API for the automated sending of SMS via Internet and API. This guide is intended for the developers and clients alike who plan to integrate their systems with our SMS services.

Base Url

Base URL will be defined as the common API URL parameters to be specified in every API. All APIs shall contain this base URL.

https://alerts.solutionsinfini.com/api/v4/?api_key=Ad9e5XXXXXXXXXXXXX

Authentication

All requests are secured through BASIC authentication via API Key (api_key) which will be provided by sms provider only. An additional level of protection is provided where API key can be configured to accept requests from a specific IP Address only. Also, API usage with username & password combination is removed due to security concerns.

Required Environment

In order to use API, one need to have a system that has internet connectivity. This may be direct internet connectivity or via a firewall or proxy server. Additionally, if anyone wish to receive delivery reports (DLRs), then one must have a web server that is able to receive incoming requests from the Internet. This web server does not necessarily have to be running on the same machine that is sending messages to us.

SSL Enabled API Triggering

These APIs has been designed to allow client to access them using an SSL Enabled connection for added security. To trigger API on an SSL enabled connection, one must enter the URL beginning with https:// instead of http://.

Our API supports both HTTP and HTTPS. Using HTTPS to encrypt all requests through SSL is recommended, but if you're using a client and tool that's not set up to make SSL requests, one can use HTTP also.

Output Restrictions

If the provider network is down, our Gateway Servers will retry your message up to six hours before giving up. Also, Duplicate messages in single request only are filtered by default. A "duplicate message" is defined as the same destination address, sender address and the message body. However, duplicate messages sent by different request are NOT filtered.

Input Restrictions

This is one of the simpler server-based method of communication. It can be used either in the form of a HTTP POST or HTTP GET. We recommend POST for larger data transfer and data security. All calls to the API must be URL-encoded. The parameter variables are case sensitive. Also, recommended to use the POST method for error free submission due to URL limitations.