Base¶
Contains API calls to health-check and send email.
API actions¶
API path: /base
.
nothing
¶
The report for health-check. It will do nothing.
Parameters¶
Only API key hash
.
Examples¶
curl -X POST 'https://api.navixy.com/v2/base/nothing' \
-H 'Content-Type: application/json' \
-d '{"hash": "22eac1c27af4be7b9d04da2ce1af111b"}'
https://api.navixy.com/v2/base/nothing?hash=a6aa75587e5c59c32d347da438505fc3
Response¶
{ "success": true }
Errors¶
- General types only.
send_email
¶
Sends email from the platform to any email address with specified title and text. Needs ROOT access level.
Parameters¶
name | description | type |
---|---|---|
from | From email address. | string |
to | To email address. | string |
title | Title of the email. | string |
message | Text of the email. | string |
service_id | Service parameter. | int |
service_pass | Service parameter. | int |
Example¶
curl -X POST 'https://api.navixy.com/v2/base/send_email' \
-H 'Content-Type: application/json' \
-d '{"hash": "22eac1c27af4be7b9d04da2ce1af111b", "from": "gps@navixy.com", "to" : "customer@email.com", "title": "test email", "message": "this email for test", "service_id": 1, "service_pass": 28}'
Response¶
{ "success": true }
Errors¶
- General types only.
Last update: October 16, 2024