Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kaue/plague-api
:globe_with_meridians: Plague Social Platform NodeJS API
https://github.com/kaue/plague-api
api nodejs npm npm-module npm-package plague wrapper
Last synced: about 2 months ago
JSON representation
:globe_with_meridians: Plague Social Platform NodeJS API
- Host: GitHub
- URL: https://github.com/kaue/plague-api
- Owner: kaue
- License: apache-2.0
- Created: 2014-12-26T11:05:17.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2018-11-24T16:34:51.000Z (about 6 years ago)
- Last Synced: 2024-04-14T14:04:41.977Z (9 months ago)
- Topics: api, nodejs, npm, npm-module, npm-package, plague, wrapper
- Language: JavaScript
- Homepage:
- Size: 63.5 KB
- Stars: 5
- Watchers: 3
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Warning: looks like Plague Social Platform was discontinued, plague.io no longer exists.
# :globe_with_meridians: plague-api
[](https://travis-ci.org/kauegimenes/plague-api) [](https://gitter.im/kauegimenes/plague-api?utm_source=badge)
Plague Social Platform NodeJS API Changelog
----------------------
v1.09 - include badges
v1.08 - include tests
v1.07 - new methods - resetPassword and confirmEmail
v1.06 - option to change locality using set function
v1.05 - fix encoding problem
v1.04 - register method
set(options)
----------------------
Set Plague Api Options
#### Parameters:
**options:** Use this to set your location.
#### Sample Code:
```javascript
var plague = require('plague-api').set({
latitude: -99.999999999999,
longitude: -99.999999999999,
administrativeArea: 'Quebec',
country: 'Canada',
locality: 'Montreal'
});
```
register(email, password, name, callback)
--------------------
Register to get UserId and Token
#### Parameters:
**email:** Your user email.
**password:** Your user password.
**name:** Your name.
**callback:** callback function.
#### Sample Code:
```javascript
plague.register('[email protected]', 'mypassword', 'My Name', function(user){
if(user.error){
console.log(user.error);
return;
}
console.log(user);
});
```
login(email, password, callback)
--------------------
Login to get UserId and Token
#### Parameters:
**email:** Your plague user email.
**password:** Your plague user password.
**callback:** callback function.
#### Sample Code:
```javascript
plague.login('[email protected]', 'mypassword', function(user){
if(user.error){
console.log(user.error);
return;
}
console.log(user);
});
```
confirmEmail(email, code, callback)
--------------------
Confirm user e-mail
#### Parameters:
**email:** Your plague user email.
**code:** Your plague confirmation code.
**callback:** callback function.
#### Sample Code:
```javascript
plague.confirmEmail('[email protected]', '1234', function(res){
console.log(res);
});
```
resetPassword(email, code, callback)
--------------------
Reset user password using e-mail
#### Parameters:
**email:** Your plague user email.
**code:** Your plague confirmation code.
**callback:** callback function.
#### Sample Code:
```javascript
plague.resetPassword('[email protected]', '1234', function(res){
console.log(res);
});
```
getPosts(callback)
----------------------
Return all user posts
#### Parameters:
**callback:** callback function.
#### Sample Code:
```javascript
plague.login('[email protected]', 'mypassword', function(user){
if(user.error){
console.log(user.error);
return;
}
//List all user posts
plague.getPosts(function(res){
var posts = res.posts;
posts.forEach(function(post) {
console.log(post);
})
});
});
```
getInfectionsNearby(callback)
----------------------
Return Nearby Plagues
#### Parameters:
**callback:** callback function.
#### Sample Code:
```javascript
plague.login('[email protected]', 'mypassword', function(user){
if(user.error){
console.log(user.error);
return;
}
plague.getInfectionsNearby(function(res){
console.log(res);
});
});
```
postText(text, callback)
----------------------
Send a text only post to Plague API
#### Parameters:
**text:** Text of the post.
**callback:** callback function.
#### Sample Code:
```javascript
plague.login('[email protected]', 'mypassword', function(user){
if(user.error){
console.log(user.error);
return;
}
plague.postText('Hello Plague', function(res){
console.log(res);
});
});
```
postLink(mediaLink, mediaLinkPreview, text, callback)
----------------------
Send a post with a Media Link
#### Parameters:
**mediaLink:** Url of the image should be around **600x600** pixels.
**mediaLinkPreview:** Url of the image should be around **300x300** pixels.
**callback:** callback function.
#### Sample Code:
```javascript
plague.login('[email protected]', 'mypassword', function(user){
if(user.error){
console.log(user.error);
return;
}
plague.postLink(
'http://domain.com/imageFull.png',
'http://domain.com/imageSmall.png',
'Hello! =)',function(res){
console.log(res);
});
});
```
deletePost(postId, callback)
----------------------
Delete a post using postId
#### Parameters:
**postId:** This is the id returned from **getPosts**.
**callback:** callback function.
#### Sample Code:
```javascript
plague.login('[email protected]', 'mypassword', function(user){
if(user.error){
console.log(user.error);
return;
}
plague.deletePost(123456,function(res){
console.log(res);
});
});
```
deleteAllPosts(postId, callback)
----------------------
Delete all user posts
#### Parameters:
**callback:** callback function.
#### Sample Code:
```javascript
plague.login('[email protected]', 'mypassword', function(user){
if(user.error){
console.log(user.error);
return;
}
plague.deleteAllPosts(function(res){
console.log(res);
});
});
```