소개
한카리 API로 봇이 켜져 있다고 알리고, 공개된 봇 정보를 읽을 수 있어요. 하트나 초대 신청 같은 이벤트는 웹훅으로 받아요.
기본 주소#
https://hankari.dev요청과 응답은 모두 JSON(UTF-8)이에요. 시각은 ISO 8601 형식의 UTC로 줘요.
엔드포인트#
| 요청 | 토큰 | 설명 |
|---|---|---|
POST /v1/bots/{id}/heartbeat | 개발자 토큰 | 가동 상태 알리기. 처음 성공한 호출이 봇 연결이에요. |
GET /v1/bots/{id} | 없음 | 공개된 봇의 방 수·가동 상태·하트 읽기 |
GET /badge/{id}/{값}.svg | 없음 | README에 붙이는 배지 이미지 |
시작하기#
- Hankari Devs에서 봇을 등록하고 개발자 토큰을 만들어요. 인증
- 봇 코드에서 heartbeat를 한 번 보내 연결해요. 봇 연결
- 봇이 켜져 있는 동안 1~5분마다 heartbeat를 보내요. 가동 상태
- 하트와 초대 신청을 받아 보고 싶다면 웹훅 주소를 저장해요. 웹훅 설정
- README나 블로그에 배지를 붙여요. README 위젯
막히는 곳이 있으면 문제 해결을, 바뀐 점은 변경 기록을 봐 주세요.
방 수#
방 수는 봇이 보고하지 않아요. 한카리 초대 신청으로 봇이 들어가 입장 완료가 된 방을 한카리가 세요. 자세히 보기