curl --request POST \
--url https://api.messaging.phonovation.com/subscriptions/1/security \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"authId": "NEWAUTH-9291",
"type": "BASIC",
"credentials": {
"username": "user1",
"password": "password1"
}
}
'import requests
url = "https://api.messaging.phonovation.com/subscriptions/1/security"
payload = {
"authId": "NEWAUTH-9291",
"type": "BASIC",
"credentials": {
"username": "user1",
"password": "password1"
}
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)using RestSharp;
var options = new RestClientOptions("https://api.messaging.phonovation.com/subscriptions/1/security");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "<api-key>");
request.AddJsonBody("{\n \"authId\": \"NEWAUTH-9291\",\n \"type\": \"BASIC\",\n \"credentials\": {\n \"username\": \"user1\",\n \"password\": \"password1\"\n }\n}", false);
var response = await client.PostAsync(request);
Console.WriteLine("{0}", response.Content);
HttpResponse<String> response = Unirest.post("https://api.messaging.phonovation.com/subscriptions/1/security")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"authId\": \"NEWAUTH-9291\",\n \"type\": \"BASIC\",\n \"credentials\": {\n \"username\": \"user1\",\n \"password\": \"password1\"\n }\n}")
.asString();<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.messaging.phonovation.com/subscriptions/1/security",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'authId' => 'NEWAUTH-9291',
'type' => 'BASIC',
'credentials' => [
'username' => 'user1',
'password' => 'password1'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
authId: 'NEWAUTH-9291',
type: 'BASIC',
credentials: {username: 'user1', password: 'password1'}
})
};
fetch('https://api.messaging.phonovation.com/subscriptions/1/security', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"authId": "<string>"
}Create security settings
This method will create new security settings.
Required scope: Enable one of: subscriptions:manage.
curl --request POST \
--url https://api.messaging.phonovation.com/subscriptions/1/security \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"authId": "NEWAUTH-9291",
"type": "BASIC",
"credentials": {
"username": "user1",
"password": "password1"
}
}
'import requests
url = "https://api.messaging.phonovation.com/subscriptions/1/security"
payload = {
"authId": "NEWAUTH-9291",
"type": "BASIC",
"credentials": {
"username": "user1",
"password": "password1"
}
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)using RestSharp;
var options = new RestClientOptions("https://api.messaging.phonovation.com/subscriptions/1/security");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "<api-key>");
request.AddJsonBody("{\n \"authId\": \"NEWAUTH-9291\",\n \"type\": \"BASIC\",\n \"credentials\": {\n \"username\": \"user1\",\n \"password\": \"password1\"\n }\n}", false);
var response = await client.PostAsync(request);
Console.WriteLine("{0}", response.Content);
HttpResponse<String> response = Unirest.post("https://api.messaging.phonovation.com/subscriptions/1/security")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"authId\": \"NEWAUTH-9291\",\n \"type\": \"BASIC\",\n \"credentials\": {\n \"username\": \"user1\",\n \"password\": \"password1\"\n }\n}")
.asString();<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.messaging.phonovation.com/subscriptions/1/security",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'authId' => 'NEWAUTH-9291',
'type' => 'BASIC',
'credentials' => [
'username' => 'user1',
'password' => 'password1'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
authId: 'NEWAUTH-9291',
type: 'BASIC',
credentials: {username: 'user1', password: 'password1'}
})
};
fetch('https://api.messaging.phonovation.com/subscriptions/1/security', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"authId": "<string>"
}Authorizations
This is the most secure authorization type and the one with the most flexibility.
API keys can be generated by calling the dedicated API method. Furthermore, API keys can have a limited scope and cover only some API methods. Lastly, they can be revoked at any time. This range of possibilities makes API keys well suited for separating the API access rights across multiple applications or use cases. Finally, the loss of an API key is easily manageable.
You can manage your API keys from GUI, or programmatically with dedicated API.
API key Authorization header example:
Authorization: App 003026bbc133714df1834b8638bb496e-8f4b3d9a-e931-478d-a994-28a725159ab9
Body
Security settings object holding the authentication settings necessary to access your webhook. Should only be provided if you are creating a new profile and settings; otherwise it will be ignored.
Unique security setting ID. Used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once an item is created.
1 - 255Credentials type.
BASIC, HMAC, OAUTH, CUSTOM Basic credentials.
- BasicCredentials
- HmacCredentials
- OauthCredentials
Show child attributes
Show child attributes
Response
Created.
Security configuration.
Unique authorization ID.