mcas-api v0.0.7
MCAS-API
- mcasAPI contains functions :
- mcasAPI.init()
- mcasAPI.isInit()
- mcasAPI.auth()
- mcasAPI.register()
- mcasAPI.overwrite()
- mcasAPI.delete()
- mcasAPI.rootAuth()
- mcasAPI.rootAuthUser()
- mcasAPI.rootList()
- mcasAPI.rootRegister()
- mcasAPI.rootOverwrite()
- mcasAPI.rootDelete()
- mcasAPI.rootFlush()
- To install mcas-api :
sudo npm install mcas-api
- In you js file you can require mcas-api using :
var mcasAPI = require('mcas-api');
- User API
/* init mcasAPI with your MCAS info (IP and PORT) */
mcasAPI.init({ MCASip : "domainNameOfMCAS", MCASport : "portOfMCAS" })
/* Authenticate User */
mcasAPI.auth({ username : "myosXcorp", password : "mxcpasswd" },
function onSuccess(UserData) {
console.log(UserData)
/* ... */
},
function onError() {
/* ... */
});
/* Normal Register, doesn't require root-access, set type of created user to 4 (User) */
/* it require an email verification to activate account */
/* (only gmail.com, yahoo.com/fr, hotmail.com/fr are allowed ) */
mcasAPI.register({ username : "myosXcorp2",
password : "myOscorpIndustries",
firstName : "Norman",
lastName : "Osborne",
email : "myosxcorp@gmail.com" },
function onResponse(response) {
console.log(response)
})
/* Allows an User to OverWrite his data, it require a new email confirmation to reActivate account */
mcasAPI.overwrite({ username : "myosXcorp2",
password : "myOscorpIndustries",
newpassword : "myOSXcorp",
firstName : "Norman",
lastName : "Osborne",
email : "myosxcorp@gmail.com" },
function onResponse(response) {
console.log(response)
})
/* Allow an User to Delete his account */
mcasAPI.delete({ username : "myosXcorp3",
password : "wolf4D" },
function onResponse(response) {
console.log(response)
})
Root API On MCAS, any user who has type set to 0 is root
/* Authenticate root user */ mcasAPI.rootAuth({ username : "rootIsME", password : "mevkspavfsgdkqgtoal" }, function onSuccess(RootUserData) { console.log(RootUserData); /* ... */ }, function onError() { /* ... */ }) /* Allows root to register new user, set his type, while bypassing email verification. */ mcasAPI.rootRegister({ username : "rootIsMe", password : "mevkspavfsgdkqgtoal", userusername : "modbIsComing", userpassword : "TequilaSunriseDataBase", firstName : "MYOS", lastName : "CORP", email : "myosxcorp@gmail.com", type : 3 }, function onResponse(registerResponse) { console.log(registerResponse) })
/ Allows Root to overwrite userdata of any user / mcasAPI.rootOverwrite({ username : "rootIsMe", password : "mevkspavfsgdkqgtoal", userusername : "modbIsComing", userpassword : "TequilaSunriseDataBase2", firstName : "MYOS", lastName : "CORP", email : "myosxcorp@gmail.com", type : 8 }, function onResponse(overwriteResponse) { console.log(overwriteResponse) })
/ Delete any user /
mcasAPI.rootDelete({ username : "rootIsMe",
password : "mevkspavfsgdkqgtoal",
userusername : "myosxcorp"
},
function onResponse(deleteResponse) {
/ ... /
})
/ Get UserData of an User / mcasAPI.rootAuthUser({ username : "rootIsMe", password : "mevkspavfsgdkqgtoal", search : "myosxcorp2" }, function onSuccess(UserData) { / ... / }, function onError() { / ... / })
/ Get the UsersArray, defined inside the file mcas/Userlist.json on your MCAS / mcasAPI.rootList({ username : "rootIsMe", password : "mevkspavfsgdkqgtoal" }, function onResponse(UsersArray) { / ... / })
/ Delete account not activated / mcasAPI.rootFlush({ username : "rootIsMe", password : "mevkspavfsgdkqgtoal" }, function onResponse(rootFlushResponse) { / ... / })
[npm-url]: https://www.npmjs.com/package/mcas-api
[npm-image]: https://img.shields.io/badge/npm%20mcas--api-0.0.1-blue.svg