HTTP(S) REST API channel
The HTTP REST API channel is a secure and easy way to integrate Auron Omni directly from your website or any other application.
Find more information about channels in general here.
Find the API reference for this channel here. You can find a number of working examples in different programming languages on GitHub here.
With the HTTP REST API channel you can create new messages and list existing messages. You can also use it to run campaigns.
The channel supports:
- HTTP and HTTPS
- JSON and XML
- IPv4 and IPv6
- API key authentication and IP authentication
Edit HTTP REST API channel
You can set up multiple instances of this API by configuring multiple channels.
Settings
| Property | Description |
| Local end point | Specify the local IP and port number that this channel listens on. The protocol can be HTTP or HTTPS for secure communication. The IP can be any available IPv4 or IPv6 address, or all of them at once. Click “configure…” to start the NetSh Express Setup. |
| End point URL | This field shows how the local end point looks. “+” means that any IP or hostname that refers to this server can be used. |
| Enable JSON API | Check this box to enable the JSON API. JSON API URLs end in “.json”. Find out more in the HTTP API Reference. |
| Enable XML API | Check this box to enable the XML API. XML API URLs end in “.xml”. Find out more in the HTTP API Reference. |
| Allow read/write to everyone | This enables everyone to use the HTTP REST API channel. Only enable this option if you are on a trusted local network. |
Authentication
On the authentication page you can specify multiple authentication items. These items apply only to the current channel.
Edit HTTP REST API channel – Authentication
The following properties are available for each authentication item:
| Property | Description |
| Description | This can be the name of the user or application that uses this item to connect. |
| Token | Specify an API key if you want this user to authenticate with an API key. If a value is specified here, it must be present in the “Authorization” header of the HTTP request. |
| IP Address | If a value is specified, this authentication item only allows access from the specified IP address. This can be either an IPv4 or IPv6 address. |
| IP Range | This checkbox determines whether the IP Address field is the start of an IP range. If this is checked, both the IP Address and the IP range end value must be set. |
| Access | Read, Write, or Read/Write. Read access allows loading and finding messages. Write access allows creating new messages to be sent. Note: Read access allows users to specify a SQL filter to find messages. This filter can be abused by untrusted users, so do not grant read access to users you do not trust. |