Skip to main content
Version: v1.4

Usage

In this section we'll be taking a look at how to use Secured Signal API.

Basic​

Here is a quick command to see if you've correctly followed the setup instructions:

curl -X POST \
    -H "Content-Type: application/json" \
    -d '{"message":"Hello, World!", "number":"<from>", "recipients":["<to>"]}' \
    'http://sec-signal-api:8880/v2/send'

This will send Hello, World! to <to> from <from>.

Auth​

Secured Signal API implements 3 auth methods:

MethodExample
Bearer AuthAuthorization: Bearer API_TOKEN (header)
Basic AuthAuthorization: Basic base64(api:API_TOKEN) (header)
http://api:API_TOKEN@host:port (client specific)
Query Authhttp://host:port/abc?@auth=API_TOKEN (query parameter)

Example:

curl -X POST \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer API_TOKEN" \
    -d '{"message":"Hello, World!", "number":"<from>", "recipients":["<to>"]}' \
    'http://sec-signal-api:8880/v2/send'