このページでは、アクセス構造と実装原則を提供しますが、変更される可能性のあるインターフェイス アドレスやフィールドはハードコーディングされていません。正式な開発については、Potato の現在の公式 Bot API マニュアルを参照してください。
API に問い合わせる概要
ボット API は、ボット開発者向けの HTTPS インターフェイスです。サーバーはユーザー インタラクションを受信し、ビジネス ロジックを実行し、API を通じてプライベート チャット、グループ、またはチャネルにコンテンツを返します。
- 通知、カスタマー サービス、クエリ、自動化ツールに適しています。
- メッセージ、コマンド、ボタン、インライン インタラクションをサポート
- ロボットの資格情報は、制御されたサーバーにのみ保存する必要があります。
- ユーザーは最初にセッションを開始するか、ロボットを追加する必要があります。
アクセスの準備
1.ロボットを作成する
Potato の現在のロボット作成プロセスに従って名前、ユーザー名、紹介文を設定し、認可トークンを取得します。
2. HTTPS サービスの準備
安定したサーバーをデプロイして、更新の受信、パラメータの確認、タスクの実行、応答の送信を行います。開発、テスト、実稼働環境は分離する必要があります。
3.管理構成
トークン、コールバック キー、および環境パラメータは、キー管理または環境構成を通じて挿入され、コード リポジトリに送信することは禁止されています。
// 概念例: 実際のフィールドとメソッドは公式ドキュメントの対象となります。 const update = verifyIncomingRequest(リクエスト) const コマンド = parseCommand(update.message) const result = await runBusinessLogic(コマンド) await PotatoBot.sendMessage(update.chatId, result)
アップデートの処理
各更新を、重複、遅延、または順番どおりに到着しない可能性のあるイベントとして扱います。更新 ID を使用して重複を排除し、時間のかかるタスク用のキューを設定し、タイムアウト後に安全に再試行します。
- まずソース、形式、必要なフィールドを確認します。
- リクエストを素早く確認し、時間のかかる操作をバックグラウンド タスクに引き継ぎます。
- イベント識別子、結果、エラーをログに記録しますが、機密テキストのログは避けてください。
- 同じユーザー、グループ、インターフェイスに対して適切なトラフィック制限を設定します。
一般的な機能
| 機能 | 一般的な用途 | 実装ポイント |
|---|---|---|
メッセージ送信 | 通知、返信、結果出力 | フォーマット、長さ、配信失敗の処理 |
コマンド | /start、/help、およびビジネス コマンド | パラメータ検証と権限チェック |
コールバックボタン | 設定、ページめくり、操作の確認 | 重複した送信を避け、迅速に対応してください。 |
インライン クエリ | セッション間でのコンテンツの検索と送信 | 高速リターン、キャッシュ、結果ページング |
グループイベント | メンバー、権限、サービス メッセージ | グループ プライバシー モードを遵守する |
エラーと再試行
パラメータ エラー、権限エラー、電流制限、一時的なネットワーク障害、サーバー エラーを区別します。ジッターを伴う指数バックオフは回復可能な問題に対してのみ使用し、最大回数を設定してください。
無限に再試行しないでください:タスクを配信できない場合、権限が取り消された場合、またはパラメータが無効な場合は、タスクを停止し、診断可能な情報を記録する必要があります。
セキュリティ要件
- 漏洩直後にトークンがローテーションされ、異常呼び出しがチェックされます。
- 管理コマンド、支払い、またはリスクの高いアクションに対して二次認証を実行します。
- サービスの完了に必要なデータのみを保存し、削除サイクルを設定します。
- ユーザー入力、URL、ファイル、リッチ テキストを検証し、フィルターします。
- インターフェイスの HTTPS、スロットル、ログ アラート、および可用性の監視を有効にします。