back channeling

กลับช่องทาง

Back Channeling เป็นเครื่องมือ BBS แบบเรียลไทม์

มันมีคุณสมบัติดังนี้:

• ติดตั้งได้อย่างง่ายดาย
• รองรับรูปแบบ Markdown
• รองรับการแชทด้วยเสียง
• การดูแลความคิดเห็น

เริ่มต้นใช้งาน

ในสถานที่

เริ่มต้น datomic transactor

 % bin/transactor

เริ่มช่องด้านหลัง

 % DATOMIC_URL=datomic:free://localhost:4334/bc bin/back_channeling

พอร์ตเริ่มต้นคือ 3009

Heroku

หรือ

1. Git Clone

 % git clone https://github.com/kawasima/back-channeling.git

1. สร้างแอปพลิเคชัน Heroku

 % cd back-channeling
% heroku create

1. ปรับใช้ช่องทางด้านหลัง

 % git push heroku master

ใช้เวลาเพียง 3 นาที !!

API

เมื่อคุณลงทะเบียนเลือกประเภทของบัญชีบอท คุณต้องจำรหัสการอนุญาต

ก่อนอื่นคุณจะได้รับโทเค็นด้วยรหัสการอนุญาต

 POST /api/token

code=[authorization code]

คุณจะได้รับการตอบกลับดังนี้:

 {"access_token": , "name": "bot", "email": "[email protected]"}

คุณต้องเพิ่มโทเค็นลงในส่วนหัว HTTP เมื่อคุณขอ backchanneling เว็บ APIs

 curl  -H 'Accept: application/json' -H 'Authorization: Token xxxxxxxxxxxxxxxx' [API url]

และหากคุณส่งคำขอโพสต์ให้เพิ่ม Content-Type ไปยังส่วนหัวคำขอ

 curl -X POST -H 'Accept: application/json' -H 'Content-Type: application/json' -H 'Authorization:  Token xxxxxxxxxxxxxxxx' [API url]

กระดาน

รับข้อมูลบอร์ด

 GET /api/board/:board-name

ตัวอย่างของการตอบสนองดังนี้:

 {
  "id":17592186045424,
  "name":"default",
  "description":"Default board",
  "threads":[
    {"id":17592186045428,
     "title":"aaa",
     "since":"20150722T101724.515Z",
     "last-updated":"20150722T110108.015Z",
     "resnum":1000,"watchers":[]},
    {"id":17592186045651,"title":"hohoho",
     "since":"20150722T104559.129Z",
     "last-updated":"20150929T123754.988Z",
     "watchers":["bot2"],"resnum":1000}
  ]
}

ด้าย

 GET /api/thread/:thread-id

กระทู้ใหม่

 POST /api/board/:board-name/threads

{"thread/name": "New thread", "comment/content": "Hello"}

โพสต์ความคิดเห็น

 POST /api/thread/:thread-id/comments

{"comment/content": "Hello"}