An API that helps developers keep up with their schedules, track dependencies, protect their data, generate testing data and keep themselves updated with the current industry standards.
\nEach individual route documentation has been attached with the API requests itself.All routes take in and give out data in json format only and in some cases using URL Parameters. Depending on the outcome each response send an appropriate status code and relevant messages and errors.
Base URL: https://spacecubes.herokuapp.com/api/
A Successful Request Will Look Like:
\n{\n \"success\": true,\n \"message\": \"Relevant Message\"\n}\nAn Unsuccessful Request Will Look Like:
\n{\n \"success\": false,\n \"error\": \"Relevant Error Message\"\n}\nReminders: This module lets the users set reminders based on date, time and purpose . All the reminders are triggered based on Indian Standard Time (IST) Whenever a reminder is triggered an email is sent to the user notifying them about the event. This route also integrates seamlessly with the newsletter route to send the pending tasks on the newsletter everyday. When the user creates a reminder for the first time using the API, a code is sent to the email, this code must then be passed everytime the user creates a reminder, gets reminders to ensure only the creator is able to read the reminders.
Dependency Trackers: This module lets developers track changes in the npm packages which their applications rely on. All the user needs is the name of the package, email to be notified and the secret code given to the user, once the tracker is set, it checks for changes and version updates within the package every 5 mins and as soon as a change is detected, an email is sent to the user notifying them about the ocurred change with the change in version number, and the link to the package. This route also offers info fetching for a particular npm package where the developer can easily retrieve all the historic info connected to that package, including latest version, version history, dependencies, files and maintainers.
Data Vault: This module lets users store their very important and sensitive data in the most efficient and secure way with multiple layers of security implemented. Each user is assigned a node, and each node can have n number of vaults under it, for example:
📦 User Node\n ┣ 📂 vault1\n ┣ 📂 vault2\n ┣ 📂 vault3\n Each Node has a password which remains same for all vaults under it and each vault has an unique code associated with it, which is unique to that particular vault. When a new vault is created an email is sent to the user with the vaultid which is needed to insert/get data.All the data is cryptographically hashed using AES 256-bit Encryption before being stored in the Database and the password and secret code is hashed using bcrypt, this data then can only be decrypted with the correct node and vault credentials. This module also allows the users to delete the entire node or delete one particular vault within the node.
Note: Node owners are notfied by email whenever an unauthorized request tries to access their vaults,delete the vault or insert data into it. When data is inserted into a vault which already has data into it, the data is overwritten.
{\n \"firstName\": \"Tony\",\n \"lastName\": \"Bernier\",\n \"userName\": \"tony.bernier\",\n \"password\": \"nonuxazufi\",\n \"email\": \"tony.bernier14@hotmail.com\",\n \"phone\": \"271.713.7192\",\n \"dob\": \"1976-11-16T20:55:45.215Z\",\n \"website\": \"https://www.jean.biz\",\n \"ip\": \"81.52.182.125\",\n \"avatar\": \"https://s3.amazonaws.com/uifaces/faces/twitter/edhenderson/128.jpg\",\n \"gravatar\": \"https://www.gravatar.com/avatar/1868462a4df8068aeec99d4f64ba098c\",\n \"address\": {\n \"country\": \"Egypt\",\n \"countryCode\": \"EG\",\n \"state\": \"Georgia\",\n \"city\": \"Carolynton\",\n \"street\": \"727 Garrett Island\",\n \"zip\": \"96301-2926\",\n \"geo\": {\n \"latitude\": -76.8663,\n \"longitude\": -112.6337\n }\n },\n \"status\": true\n }\nThis module is not limited to just people profiles, it can also generate full length company profiles, array of emails, uuids, full-length addresses and much more. This module also offers a custom data route which can generate dynamic random data based on a template, for example Hi, my name is #{names.name}. I was born in #{address.city}, #{address.country}. I am #{date.age} years old. will generate: Hi, my name is Mrs. Marta Powlowski. I was born in West Laura, Wallis & Futuna. I am 41 years old.
Note: All requests are capped to 5000 to reduce sercer load issues
Gets all the reminders associated with an email irrespective of if they have already been triggered or not
\nRequired Parameters
\nemail: The email to be notified
\ncode: The secret code sent by email, if not already set the API automatically sends one
This route sets a reminder based on the given inputs (All times are considered in IST). When the reminder is triggered an email is sent immediately.
\nRequired Parameters
\nemail: The email to be notified
\ncode: The secret code sent by email, if not already set the API automatically sends one
\ndate: The date for the reminder in the format \"dd/mm/yyyy\"
\ntime: The time for the reminder in the format \"hh:mm\"
Optional Parameters
\npurpose: The description for the reminder
Gets all the available information about a npm package from the NPM Registry, inlcuding all version information, contributors, maintainers,dependencies etc.
\nRequired Parameters
\nemail: The email to be notified
\npkgName: The name of the npm package as it appears on the npm website
Gets Dependency Info
Gets all the dependency trackers associated with the provided email address
\nRequired Parameters
\nemail: The email to be notified
\ncode: The secret code sent by email, if not already set the API automatically sends one
Gets all dependency trackers
Sets a dependency tracker based on the provided input, then it checks for updates on the said npm package every 5 mins and if any new changes are detected, sends an email notifiying about the update in version
Required Parameters
\nemail: The email to be notified
\ncode: The secret code sent by email, if not already set the API automatically sends one
\npkgName: The name of the npm package
Set a dependency tracker
Ever wanted random fake profiles to test your UI, or to test that DB? This route takes in two URL Params one being gender which should one of [male/female/mixed] and second parameter being qty specifying the amount of profiles to be generated and is capped at 5000
https://spacecubes.herokuapp.com/api/generator/people/:gender/:qty
Male Profile Example:
\n{\n \"firstName\": \"Terry\",\n \"lastName\": \"Volkman\",\n \"userName\": \"terry.volkman98\",\n \"password\": \"zuxamegopo\",\n \"email\": \"terry.volkman95@hotmail.com\",\n \"phone\": \"(742) 614-7032 x5063\",\n \"dob\": \"1980-07-19T09:23:21.497Z\",\n \"website\": \"http://www.vicky-price.org\",\n \"ip\": \"193.103.211.83\",\n \"avatar\": \"https://s3.amazonaws.com/uifaces/faces/twitter/adhiardana/128.jpg\",\n \"gravatar\": \"https://www.gravatar.com/avatar/eef50ebd172a6aaf9acfe243f08564eb\",\n \"address\": {\n \"country\": \"Kiribati\",\n \"countryCode\": \"KI\",\n \"state\": \"Nevada\",\n \"city\": \"Mablebury\",\n \"street\": \"67275 Myron Mountain Suite 940\",\n \"zip\": \"98000-5145\",\n \"geo\": {\n \"latitude\": -38.7591,\n \"longitude\": 168.90949999999998\n }\n },\n \"status\": true\n }\nA route to generate random fake addresses.This route takes in one URL Params, qty specifying the amount of addresses to be generated and is capped at 5000
https://spacecubes.herokuapp.com/api/generator/address/:qty
Sample Data:
\n{\n \"country\": \"France\",\n \"countryCode\": \"FR\",\n \"state\": \"North Carolina\",\n \"city\": \"Port Carmen\",\n \"street\": \"457 Durgan Camp Suite 722\",\n \"zip\": \"11416\",\n \"geo\": {\n \"latitude\": 75.6138,\n \"longitude\": 16.535799999999995\n }\n }\nA route to generate random fake company profiles.This route takes in one URL Params, qty specifying the amount of companies to be generated and is capped at 5000
https://spacecubes.herokuapp.com/api/generator/company/:qty
{\n \"name\": \"Fritsch LLC\",\n \"email\": \"fritsch-llc.cartwright71@gmail.com\",\n \"phone\": \"461-119-1327\",\n \"website\": \"https://www.clyde.eu\",\n \"ip\": \"7.27.105.62\",\n \"address\": {\n \"country\": \"Macau SAR China\",\n \"countryCode\": \"MO\",\n \"state\": \"South Carolina\",\n \"city\": \"North Bettyview\",\n \"street\": \"7627 Upton Landing\",\n \"zip\": \"28277\",\n \"geo\": {\n \"latitude\": 55.0343,\n \"longitude\": 7.519200000000012\n }\n }\n }\nA route to generate random fake blog posts.This route takes in one URL Params, qty specifying the amount of blog posts to be generated and is capped at 5000
https://spacecubes.herokuapp.com/api/generator/blogs/:qty
Sample Data:
\n{\n \"title\": \"Exercitationem sint earum est cupiditate tempora qui amet fugiat.\",\n \"keywords\": [\n \"sed\",\n \"ipsum\",\n \"et\"\n ],\n \"created\": \"2021-01-21T17:06:50.840Z\",\n \"content\": \"Molestias temporibus architecto necessitatibus cupiditate quidem perferendis nulla nesciunt velit. Voluptas ut nemo omnis. Reiciendis vel sit aspernatur adipisci fugit. Voluptatem voluptatem id ut et quia magni molestiae aut. Cum necessitatibus animi aut ex. Repudiandae et similique.\\r\\nNulla aliquid in totam fugiat ut eaque tenetur. Tenetur eos nemo. Non iusto recusandae et dolore perferendis assumenda qui minus minus. Cum et reiciendis nemo dignissimos nemo dolorem.\\r\\nPariatur cupiditate possimus. Omnis sit est asperiores a. Est illo velit facere optio delectus nam. Natus iure alias magni tenetur aut. Dignissimos non sint voluptate porro ut voluptates.\"\n }\nA route to generate random UUIDs.This route takes in one URL Params, qty specifying the amount of UUIDs to be generated and is capped at 5000
https://spacecubes.herokuapp.com/api/generator/uuid/:qty
Sample Data:
\n[\n \"fa00420b-df65-42a9-a8a3-37166951950b\",\n \"74bdcba7-9d42-43e2-ae53-23f295e07c5a\",\n \"413cc388-f29a-47ab-87f2-8b00a829627f\",\n \"ccb18499-1fb0-4ae9-9fcc-3c1f04815074\",\n \"d9878d87-0cf2-44f5-b2d1-5febd856ed72\",\n \"5ccd9e37-5a90-4168-8715-6cdc7fcaf98b\",\n \"1a1bb7da-115d-45d9-8d0e-c325373cb9e7\",\n \"e6b34f31-ae4a-4f81-a1c8-1bc00c3decc7\",\n \"070e7a04-5fa8-4411-b3a8-ccbcfe50b7d2\",\n \"1a564263-fe4a-42ce-8fcd-0b2a1e7e8beb\"\n ]\nA route to generate random fake emails.This route takes in one URL Params, qty specifying the amount of emals to be generated and is capped at 5000
https://spacecubes.herokuapp.com/api/generator/email/:qty
Sample Data:
\n[\n \"matt56@gmail.com\",\n \"rosemarie93@yahoo.com\",\n \"monicabruen38@gmail.com\",\n \"lela63@yahoo.com\",\n \"pennyjerde74@gmail.com\",\n \"justin.botsford@hotmail.com\",\n \"rodolfo.lowe28@yahoo.com\",\n \"loretta.abshire83@yahoo.com\",\n \"brendan.pacocha@yahoo.com\",\n \"catherine.doyle@yahoo.com\"\n ]\nGenerates Lorem sentences, words or entire paragraphs.This route takes in two URL Params one being entity which should one of [word/sentence/paragraph] and second parameter being qty specifying the amount of lorems to be generated and is capped at 5000
https://spacecubes.herokuapp.com/api/generator/lorem/:entity/:qty
Sample \"Sentence\" Data:
\n[\n \"Ipsum alias sit ea alias.\",\n \"Eius iure voluptatibus.\",\n \"Maiores ipsa esse quia quia magni.\",\n \"Ut corporis et quaerat iure quia illo natus.\",\n \"Consequatur aliquid minima rem rem modi officia modi.\",\n \"Est dolore et magni ipsam eum.\",\n \"Repellendus est laboriosam quo sequi necessitatibus.\",\n \"Quo hic tenetur voluptas accusamus sequi ex omnis sed.\",\n \"Et sequi alias non.\",\n \"Sapiente dolorum voluptatem nulla eveniet illo excepturi.\"\n ]\nGenerates custom sentences.
\nhttps://spacecubes.herokuapp.com/api/generator/custom/:qty
Sample Data:
\n[\n \"Hi, my name is Billy Keeling. I was born in West Jackshire, Palau. I am 54 years old.\",\n \"Hi, my name is Dustin Jacobs. I was born in Veumtown, Burundi. I am 73 years old.\",\n \"Hi, my name is Mary Langworth. I was born in Samfurt, Madagascar. I am 80 years old.\",\n \"Hi, my name is Dawn Pfannerstill. I was born in Bartonland, Belarus. I am 47 years old.\",\n \"Hi, my name is Darrin Rath. I was born in Faheymouth, Taiwan. I am 33 years old.\",\n \"Hi, my name is Marsha Conn. I was born in Gregmouth, Caribbean Netherlands. I am 25 years old.\",\n \"Hi, my name is Dr. Gary Hilpert. I was born in South Vanbury, Madagascar. I am 23 years old.\",\n \"Hi, my name is Bryant Wolf. I was born in Strosinburgh, Laos. I am 39 years old.\",\n \"Hi, my name is Melissa O'Kon. I was born in Roweborough, Spain. I am 58 years old.\",\n \"Hi, my name is Leo Labadie. I was born in Abshireport, Saudi Arabia. I am 26 years old.\"\n ]\nThis route creates a vault under the node associated with that user. If no node exists, a new node is created and a vault is added.After this an email is sent to that email with the vaultid for the new vault created
Required Parameters
\nemail: The email associated/to be connected to the vault
\npassword: The secret password associated with your node, this remains same for all vaults under this user
\ncode: The secret code for this particular vault and is unique to this vault only
This route lets the vault owner insert data into one of their vaults under their node. This data is then encrypted and stored and can be decrypted with the right request and credentials
\nRequired Parameters
\nemail: The email associated to the node in which this vault resides
\npassword: The secret password associated with your node, this remains same for all vaults under this user
\ncode: The secret code for the vault trying to be accessed
\nvaultid: The ID for the vault trying to be accessed sent by email
\ndata: The data to be stored in this vault
This route lets the vault owner get all the data previously stored from one of the vaults under their node.After the data is retrieved and decrypted an email is sent to the user with all the accessed data.
\nRequired Parameters
\nemail: The email associated to the node in which this vault resides
\npassword: The secret password associated with your node, this remains same for all vaults under this user
\ncode: The secret code for the vault trying to be accessed
\nvaultid: The ID for the vault trying to be accessed sent by email
This route lets the node owner delete the entire node assocated to them which in turn deletes all the vaults created within the node, or just delete one specific vault without affecting any other vault
\nRequired Parameters
\nemail: The email associated to the node in which this vault resides
\npassword: The secret password associated with your node, this remains same for all vaults under this user
\ncode: The secret code for the vault trying to be accessed
\nvaultid: The ID for the vault trying to be accessed sent by email (Required only if 'option' parameter is set to \"vault\"
\noption: The operation to be performed, must be one of vault`` or node```
This route lets the user check if he/she is subscrbed to this API's daily newsletter.
\nRequired Parameters
\nemail: The email to be checked
This route lets the user to subscribe to the daily newsletter
\nRequired Parameters
\nemail: The email to be subscribed
This route lets the user to unsubcribe from thje daily newsletter
\nRequired Parameters
\nemail: The email to be unsubscribed
\ncode: The secret code sent by email, if not already set the API automatically sends one