{"id":21271656,"url":"https://github.com/kaue/plague-api","last_synced_at":"2025-07-11T05:33:00.081Z","repository":{"id":25087783,"uuid":"28508580","full_name":"kaue/plague-api","owner":"kaue","description":":globe_with_meridians: Plague Social Platform NodeJS API","archived":false,"fork":false,"pushed_at":"2018-11-24T16:34:51.000Z","size":65,"stargazers_count":5,"open_issues_count":1,"forks_count":1,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-04-14T14:04:41.977Z","etag":null,"topics":["api","nodejs","npm","npm-module","npm-package","plague","wrapper"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/kaue.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-12-26T11:05:17.000Z","updated_at":"2024-04-14T14:04:41.978Z","dependencies_parsed_at":"2022-08-23T15:40:53.348Z","dependency_job_id":null,"html_url":"https://github.com/kaue/plague-api","commit_stats":null,"previous_names":["kauegimenes/plague-api"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kaue%2Fplague-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kaue%2Fplague-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kaue%2Fplague-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kaue%2Fplague-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kaue","download_url":"https://codeload.github.com/kaue/plague-api/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225697960,"owners_count":17510046,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","nodejs","npm","npm-module","npm-package","plague","wrapper"],"created_at":"2024-11-21T08:27:45.304Z","updated_at":"2024-11-21T08:27:45.823Z","avatar_url":"https://github.com/kaue.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Warning: looks like Plague Social Platform was discontinued, plague.io no longer exists.\n\n\n\n\n\n# :globe_with_meridians: plague-api \n\n[![Build Status](http://img.shields.io/travis/kauegimenes/plague-api.svg)](https://travis-ci.org/kauegimenes/plague-api)   [![Gitter](https://img.shields.io/badge/gitter-join_chat-blue.svg?style=flat)](https://gitter.im/kauegimenes/plague-api?utm_source=badge)\n\n\n\nPlague Social Platform NodeJS API Changelog\n----------------------\nv1.09 - include badges\u003cbr\u003e\nv1.08 - include tests\u003cbr\u003e\nv1.07 - new methods - resetPassword and confirmEmail\u003cbr\u003e\nv1.06 - option to change locality using set function\u003cbr\u003e\nv1.05 - fix encoding problem\u003cbr\u003e\nv1.04 - register method\u003cbr\u003e\n\nset(options)\n----------------------\nSet Plague Api Options\n#### Parameters:\n**options:** Use this to set your location.\n#### Sample Code:\n```javascript\nvar plague = require('plague-api').set({\n  latitude: -99.999999999999,\n  longitude: -99.999999999999,\n  administrativeArea: 'Quebec',\n  country: 'Canada',\n  locality: 'Montreal'\n});\n```\n\nregister(email, password, name, callback)\n--------------------\nRegister to get UserId and Token\n#### Parameters:\n**email:** Your user email.\u003cbr\u003e\n**password:** Your user password.\u003cbr\u003e\n**name:** Your name.\u003cbr\u003e\n**callback:** callback function.\n#### Sample Code:\n```javascript\nplague.register('sample@domain.com', 'mypassword', 'My Name', function(user){\n  if(user.error){\n    console.log(user.error);\n    return;\n  }\n  console.log(user);\n});\n```\n\nlogin(email, password, callback)\n--------------------\nLogin to get UserId and Token\n#### Parameters:\n**email:** Your plague user email.\u003cbr\u003e\n**password:** Your plague user password.\u003cbr\u003e\n**callback:** callback function.\n#### Sample Code:\n```javascript\nplague.login('sample@domain.com', 'mypassword', function(user){\n  if(user.error){\n    console.log(user.error);\n    return;\n  }\n  console.log(user);\n});\n```\n\nconfirmEmail(email, code, callback)\n--------------------\nConfirm user e-mail\n#### Parameters:\n**email:** Your plague user email.\u003cbr\u003e\n**code:** Your plague confirmation code.\u003cbr\u003e\n**callback:** callback function.\n#### Sample Code:\n```javascript\nplague.confirmEmail('sample@domain.com', '1234', function(res){\n  console.log(res);\n});\n```\n\nresetPassword(email, code, callback)\n--------------------\nReset user password using e-mail\n#### Parameters:\n**email:** Your plague user email.\u003cbr\u003e\n**code:** Your plague confirmation code.\u003cbr\u003e\n**callback:** callback function.\n#### Sample Code:\n```javascript\nplague.resetPassword('sample@domain.com', '1234', function(res){\n  console.log(res);\n});\n```\n\ngetPosts(callback)\n----------------------\nReturn all user posts\n#### Parameters:\n**callback:** callback function.\n#### Sample Code:\n```javascript\nplague.login('sample@domain.com', 'mypassword', function(user){\n  if(user.error){\n    console.log(user.error);\n    return;\n  }\n  //List all user posts\n  plague.getPosts(function(res){\n    var posts = res.posts;\n    posts.forEach(function(post) {\n      console.log(post);\n    })\n  });\n});\n```\n\ngetInfectionsNearby(callback)\n----------------------\nReturn Nearby Plagues\n#### Parameters:\n**callback:** callback function.\n#### Sample Code:\n```javascript\nplague.login('sample@domain.com', 'mypassword', function(user){\n  if(user.error){\n    console.log(user.error);\n    return;\n  }\n  plague.getInfectionsNearby(function(res){\n    console.log(res);\n  });\n});\n```\n\npostText(text, callback)\n----------------------\nSend a text only post to Plague API\n#### Parameters:\n**text:** Text of the post.\u003cbr\u003e\n**callback:** callback function.\n#### Sample Code:\n```javascript\nplague.login('sample@domain.com', 'mypassword', function(user){\n  if(user.error){\n    console.log(user.error);\n    return;\n  }\n  plague.postText('Hello Plague', function(res){\n    console.log(res);\n  });\n});\n```\n\npostLink(mediaLink, mediaLinkPreview, text, callback)\n----------------------\nSend a post with a Media Link\n#### Parameters:\n**mediaLink:** Url of the image should be around **600x600** pixels.\u003cbr\u003e\n**mediaLinkPreview:** Url of the image should be around **300x300** pixels.\u003cbr\u003e\n**callback:** callback function.\n#### Sample Code:\n```javascript\nplague.login('sample@domain.com', 'mypassword', function(user){\n  if(user.error){\n    console.log(user.error);\n    return;\n  }\n  plague.postLink(\n    'http://domain.com/imageFull.png',\n    'http://domain.com/imageSmall.png',\n    'Hello! =)',function(res){\n      console.log(res);\n    });\n});\n```\n\ndeletePost(postId, callback)\n----------------------\nDelete a post using postId\n#### Parameters:\n**postId:** This is the id returned from **getPosts**.\u003cbr\u003e\n**callback:** callback function.\n#### Sample Code:\n```javascript\nplague.login('sample@domain.com', 'mypassword', function(user){\n  if(user.error){\n    console.log(user.error);\n    return;\n  }\n  plague.deletePost(123456,function(res){\n    console.log(res);\n  });\n});\n```\n\ndeleteAllPosts(postId, callback)\n----------------------\nDelete all user posts\n#### Parameters:\n**callback:** callback function.\n#### Sample Code:\n```javascript\nplague.login('sample@domain.com', 'mypassword', function(user){\n  if(user.error){\n    console.log(user.error);\n    return;\n  }\n  plague.deleteAllPosts(function(res){\n    console.log(res);\n  });\n});\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkaue%2Fplague-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkaue%2Fplague-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkaue%2Fplague-api/lists"}