Alerter System API接口

接入教程

1. 访问API测试平台页面
2. 查看可用授权方式
3. 选择接口端点
4. 填写必要参数
5. 执行API调用
6. 查看返回结果

Python：获取警报列表

python

import requests

url = "https://api.example.com/v1/alerts"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json"
}

params = {
    "limit": 10,
    "status": "active"
}

response = requests.get(url, headers=headers, params=params)
if response.status_code == 200:
    data = response.json()
    print(f"Retrieved {len(data.get('alerts', []))} alerts")
else:
    print(f"Error: {response.status_code}", response.text)

PHP：创建新警报

php

<?php

$url = "https://api.example.com/v1/alerts";
$apiKey = "YOUR_API_KEY";

$data = [
    "title" => "Service Monitoring",
    "message" => "High CPU usage detected",
    "severity" => "high"
];

$ch = curl_init($url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "Authorization: Bearer " . $apiKey,
    "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));

$response = curl_exec($ch);
$httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

if ($httpCode == 201) {
    echo "Alert created successfully.";
} else {
    echo "Error: " . $httpCode . " - " . $response;
}

?>

JavaScript：更新警报状态

javascript

const fetch = require('node-fetch');

async function updateAlertStatus(alertId, newStatus) {
    const url = `https://api.example.com/v1/alerts/${alertId}`;
    
    const response = await fetch(url, {
        method: 'PATCH',
        headers: {
            'Authorization': `Bearer YOUR_API_KEY`,
            'Content-Type': 'application/json'
        },
        body: JSON.stringify({
            "status": newStatus
        })
    });
    
    if (response.ok) {
        const data = await response.json();
        console.log(`Alert ${alertId} updated to ${newStatus}`);
        return data;
    } else {
        console.error(`Error: ${response.status}`, await response.text());
        throw new Error(`Failed to update alert: ${response.status}`);
    }
}

// Example usage
// updateAlertStatus('alert_123', 'resolved');

常见问题

如何获取API密钥？

请登录Alerter System账户，访问API设置页面生成或管理您的API密钥。请妥善保管，切勿在客户端代码中暴露。

API调用频率有限制吗？

是的，根据您的订阅计划，API有每分钟和每日的调用次数限制。超出限制将返回429状态码。具体限制请参阅API文档的速率限制部分。

测试平台和正式API有什么区别？

测试平台主要用于交互式探索API功能，其授权方式仅适用于该界面。正式集成请使用文档中描述的API密钥认证，并指向生产环境的基础URL。