/Dcard-API

Primary LanguageJavaScript

Dcard-API

這個 Node.js package 提供一套符合 Promise/A+ 標準的 API,有登入、取得好友、今日抽卡等等功能,目前還在持續新增中,如果需要什麼 API 也可以開個 Issue 讓我知道。

環境需求

  • node >= 3.22.34

安裝

npm install Larry850806/Dcard-API

如何使用

var DcardAPI = require('DcardAPI');

var email = 'Dcard_Email';
var password = 'Dcard_Password';

// 登入並取得今天的卡
DcardAPI.login({email: email, password: password}).then(function(res){
    
    return DcardAPI.getDcard();

}).then(function(dcard){

    console.log('今天的卡:');
    console.log(dcard);
    console.log();

}).catch((err) => {

    // 檢查有沒有錯誤
    console.log(err);

});

API 文件

成功時資料會從 resolve 傳回去,失敗時錯誤會從 reject 傳回去,所以記得要確認 response 跟 catch。


取得目前開放的所有學校

參數

  • allSchool: 一個陣列,包含目前開放的所有學校
Dcard.getAllSchool().then(function(allSchool){
    console.log(allSchool);
});

登入並獲取權限

參數

  • Dcard_Email: Dcard 的帳號
  • Dcard_Password: Dcard 的密碼
  • response: 一個字串,登入成功會傳回 "login success"
var account = {
    email: Dcard_Email,
    password: Dcard_Password
};

DcardAPI.login(account).then(function(response){
    console.log(response);
});

得到今日卡友的資訊

參數

  • dcard: 今天的卡,包含名字、系級、照片等等,若沒有卡則傳回 "today no card"
DcardAPI.getDcard().then(function(dcard){
    console.log(dcard);
});

得到所有好友的資訊

參數

  • allFriendInfo: 一個陣列,包含每個好友的 id、名字、系級、照片等等
DcardAPI.getAllFriendInfo().then(function(allFriendInfo){
    console.log(allFriendInfo);
});

刪掉某個卡友

參數

  • id: 好友 id,可以從getAllFriendInfo()得到
  • response: 一個字串,刪除成功會傳回 "delete success"
DcardAPI.getAllFriendInfo().then(function(allFriendInfo){
    var id = allFriendInfo[0].id        // 第一個卡友的 id
    return DcardAPI.deleteFriend(id);   // 刪掉第一個卡友
}).then(function(response){
    console.log(response);      // 檢查 response 看有沒有成功刪掉
});

得到跟某個卡友的寫信記錄

參數

  • id: 好友 id,可以從getAllFriendInfo()得到
  • message: 裡面包含很多封信,每一封信都包含內容、時間等等
DcardAPI.getAllFriendInfo().then(function(allFriendInfo){
    var id = allFriendInfo[0].id        // 第一個卡友的 id
    return DcardAPI.getMessage(id);     // 得到跟第一個卡友的記錄
}).then(function(message){
    console.log(message);
});