Bezpieczeństwo
Konfigurując punkty końcowe elementu webhook, możesz zabezpieczyć aplikację przed niechcianymi żądaniami, konfigurując klucz tajny elementu webhook. Każdy podpis żądania jest tworzony przy użyciu algorytmu mieszającego HMAC_SHA256. Algorytm podpisuje ładunek webhooka podanym kluczem tajnym. Wynikowy skrót jest zawarty w nagłówku podpisu żądania w następującym formacie:
X-TopMessage-Signature: {TOPMESSAGE_HMAC_SIGNATURE}Zarządzaj punktami końcowymi webhooka
tutaj
Przykłady przypadków użycia
Poniżej przedstawiono kilka przykładów przypadków użycia interfejsu API TopMessage:
Pełne parametry żądania
| Nazwa | Uprzejmy | Opis |
|---|---|---|
| data | object | Zawiera informacje o wiadomości. |
Data Object
| Nazwa | Uprzejmy | Opis |
|---|---|---|
| id | string | Unikalny identyfikator Twojej wiadomości. |
| request_id | string | Unikalny identyfikator żądania wygenerowanego przez Ciebie w celu śledzenia żądań. Domyślny: NULL |
| channel | string | Kanał komunikacyjny przesyła Twoją wiadomość. Możliwe wartości: SMS I WHATSAPP |
| status | string | Początkowy status Twojej wiadomości. Możliwe wartości: PENDING, FAILED, DELIVERED, SEEN |
| type | string | Typ zdarzenia powiązanego z wiadomością. |
POST
https://{twoja_domena}/twoj_webhook/sciezkaX-Topmessage-Signature: {TOPMESSAGE_HMAC_SIGNATURE}
Content-Type: application/jsonPoproś o próbkę
Payload
Java
Python
PHP
Node.js
C#
{
"data": {
"id": "b04fc4d3-f232-46b7-b66b-538c0d4b3404",
"request_id": "b04fc4d3-f232-46b7-b66b-538c0d4b3404",
"channel": "SMS",
"status": "DELIVERED",
"type": "STATUS"
}
}Próbka odpowiedzi
200 OK