How to create an HTTP API user

In order to use the HTTP API, you need to create an HTTP API user. During this procedure you will be able to specify a username and a password. You can use this username and password to connect to the HTTP API service of Ozeki SMS Gateway to submit your messages, or to download the incoming messages. This guide gives you the steps to take to setup an HTTP API user.

Prerequisites

Ozeki sms gateway needs to be installed

Video tutorial

Step 1 - Add new user/application

You can simply install the HTTP API User on the Management console by clicking Add new user/application... in the Users/Applications panel (Figure 1).

add new user or application
Figure 1 - Add new user/application...

Step 2 - Add HTTP API User

An interface will open consisting of two panels. The left side panel contains the already installed users and applications. The right side panel contains the users and applications you can install with a brief description next to them. Find the HTTP API User and click the blue 'install' button next to it (Figure 2).

add http api user
Figure 2 - Add HTTP API User

Step 3 - Configure username and password

On the Name section provide the unique name for the HTTP User and provide the username and password for the authentication (Figure 3).

configure username and password
Figure 3 - Configure username and password

Step 4 - HTTP API User details page

After you click on the OK the details page of the HTTP User will appear (Figure 4).

http api user details page
Figure 4 - HTTP API User details page

Step 5 - HTTP API Service

In the advanced menu you can find the HTTP API service for the user. Open the details page of the service as you can see on the Figure 5.

http api service
Figure 5 - HTTP API Service

Step 6 - HTTP Service events

The HTTP service Events tab shows the logs for the HTTP API and here you can see the port where the service is listening for the requests (Figure 6).

http service events
Figure 6 - HTTP Service events

Step 7 - Send an HTTP request form your application

The HTTP API service is capable of receiving HTTP requests from your application. This can be done by using the SMS API, that can initiate HTTP requests and send them to the HTTP API service that can process the HTTP requests and sends the SMS message. The link below contain example codes of how you can send SMS messages from applications written in different programming languages.

HTTP SMS API examples
How to send SMS from C#
How to send SMS from Java
How to send SMS from Python
How to send SMS from Ruby
How to send SMS from Perl
How to send SMS from PHP
How to send SMS from Chrome

Step 8 - Message received

If a message is received by the HTTP API service you can see it in the logs (Figure 7).

message received
Figure 7 - Message received

Step 9 - HTTP API User sent folder

Also you can find the message in the HTTP API user Sent folder (Figure 8).

http api user sent folder
Figure 8 - HTTP API User sent folder

Summary

This article is about creating an HTTP API user. Having an HTTP API user means that you can use the HTTP API with your software. This article will show you how to specify a username and a password to have better security. The HTTP API will make implementing an SMS function to your software easy to satisfy customer needs.

If you would like to find out more information about the Ozeki SMS Gateway, make sure to visit the Ozeki webpage. We advise you to start with the page about the HTTP SMS API Also, you can get more information about sending SMS with the HTTP SMS API.

Now your next thing to do is to download Ozeki SMS Gateway and configure this solution immediately! Everything is there to get it up and running in less than 10 minutes.

More information