이 페이지는 액세스 구조와 구현 원칙을 제공하며 변경될 수 있는 인터페이스 주소나 필드를 하드코딩하지 않습니다. 공식적인 개발을 위해서는 Potato의 현재 공식 Bot API 매뉴얼을 참조하세요.
API 개요
Bot API는 봇 개발자를 위한 HTTPS 인터페이스입니다. 서버는 사용자 상호작용을 수신하고, 비즈니스 로직을 수행하고, API를 통해 비공개 채팅, 그룹 또는 채널에 콘텐츠를 반환합니다.
- 알림, 고객 서비스, 쿼리 및 자동화 도구에 적합
- 메시지, 명령, 버튼 및 인라인 상호 작용 지원
- 로봇 자격 증명은 제어되는 서버에만 저장되어야 합니다.
- 사용자는 먼저 세션을 시작하거나 로봇을 추가해야 합니다.
액세스 준비
1. 로봇 만들기
Potato의 현재 로봇 생성 프로세스에 따라 이름, 사용자 이름, 소개를 설정하고 인증 토큰을 얻습니다.
2. HTTPS 서비스 준비
업데이트 수신, 매개변수 확인, 작업 수행 및 응답 보내기를 위해 안정적인 서버를 배포합니다. 개발, 테스트 및 프로덕션 환경은 격리되어야 합니다.
3. 관리 구성
토큰, 콜백 키 및 환경 매개변수는 키 관리 또는 환경 구성을 통해 주입되며 코드 저장소에 제출이 금지됩니다.
// 개념 예시: 실제 필드와 메소드는 공식 문서를 따릅니다. const 업데이트 = verifyIncomingRequest(요청) const 명령 = parsCommand(update.message) const 결과 = runBusinessLogic(명령) 대기 PotatoBot.sendMessage(update.chatId, 결과)를 기다립니다
업데이트 처리 중
각 업데이트를 중복, 지연 또는 순서 없이 도착할 수 있는 이벤트로 처리하세요. 업데이트 ID를 사용하여 중복을 제거하고, 시간이 많이 소요되는 작업에 대한 대기열을 설정하고, 시간 초과 후 안전하게 재시도하세요.
- 먼저 소스, 형식, 필수 필드를 확인하세요.
- 요청을 신속하게 확인하고 시간이 많이 걸리는 작업을 백그라운드 작업에 넘겨주세요.
- 이벤트 식별자, 결과, 오류를 기록하되 민감한 텍스트는 기록하지 마세요.
- 동일한 사용자, 그룹 및 인터페이스에 대해 합리적인 트래픽 제한을 설정하세요.
공통 기능
| 기능 | 일반적인 용도 | 구현 지점 |
|---|---|---|
메시지 보내기 | 알림, 답글, 결과 출력 | 형식, 길이, 전송 실패 처리 |
명령 | /start, /help 및 비즈니스 명령 | 매개변수 확인 및 권한 확인 |
콜백 버튼 | 설정, 페이지 넘기기, 작업 확인 | 중복 제출을 방지하고 신속하게 응답 |
인라인 쿼리 | 세션 전반에 걸쳐 콘텐츠 검색 및 전송 | 빠른 반환, 캐싱 및 결과 페이징 |
그룹 이벤트 | 회원, 권한 및 서비스 메시지 | 그룹 개인정보 보호 모드 준수 |
오류 및 재시도
매개변수 오류, 권한 오류, 전류 제한, 일시적인 네트워크 오류, 서버 오류를 구별합니다. 복구 가능한 문제에 대해서는 지터가 포함된 지수 백오프만 사용하고 최대 횟수를 설정하세요.
무한 재시도하지 마세요:작업을 전달할 수 없거나 권한이 취소되거나 매개변수가 유효하지 않은 경우 작업을 중지하고 진단 가능한 정보를 기록해야 합니다.
보안 요구사항
- 토큰은 유출 즉시 순환되며 비정상적인 호출을 검사합니다.
- 관리 명령, 결제 또는 고위험 행위에 대해 2차 인증을 수행합니다.
- 서비스 완료에 필요한 데이터만 저장하고 삭제 주기를 설정하세요.
- 사용자 입력, URL, 파일 및 서식 있는 텍스트를 검증하고 필터링합니다.
- 인터페이스에 대해 HTTPS, 제한, 로그 경고 및 가용성 모니터링을 활성화합니다.