This project is a serverless API for (JSON) data storage. It is available to experimental, Proof of Concept, academic or hackathon-related projects as a realiable and easy to use storage solution. No hosting, no database.
Its purpose: Storing, updating, retrieving and also erasing JSON data on the go 🤷
There are two ways of accessing this API:
- Fork it on Serverless Cloud here. This way you'll have your own personal storage API, which can be scaled for you or your team as much as you like.
- Request an authentication token and start sending requests to the URLs (the process is explanied below).
- Save/Update/Overwrite (POST):
/data
- Retrieve (GET):
/data/:keyName
- Delete (DELETE):
/data/:keyName
- key:
api_key
- value: I will create your own personal token, so shoot me an email!
(POST Request: /data
)
Make a request using the following JSON-parsed body structure:
{
"content": {
'your data goes in here..'
},
"instructions": {
"keyName": "testKey"
}
}
Resending content using the same key name will append that body to the previously saved key, generating an update action.
Using the same body, include the overwrite
boolean attribute inside of "instructions. The overwrite should be sent on true
{
"content": {
"newData": "This should overwrite"
},
"instructions": {
"keyName": "testKey",
"overwrite": true
}
}
(GET Request: /data/:keyName
)
- Use the following header for the example => [ api_key: test_token2465 ]
(DELETE Request: /data/:keyName
)
- Health check cron: A scheduler function running every 2 hours. Checks the status of the app.
- Email Service (optional): If any error is identified on the network, an email may be sent as a "wake-up call". (current recipient: myself 😅)