Skip to content

Latest commit

 

History

History
84 lines (57 loc) · 1.4 KB

README.md

File metadata and controls

84 lines (57 loc) · 1.4 KB

Blocks

Blocks is a simple, efficient HTTP-based JSON storage service that provides you with a personalized endpoint for performing CRUD (Create, Read, Update, Delete) operations on your data.

Features

  • Easy signup process
  • Personalized endpoint for each user
  • Simple HTTP-based API
  • JSON data storage
  • CRUD operations support
  • Secure and scalable

Getting Started

1. Sign Up

To start using Blocks, sign up at our website. Upon successful registration, you'll receive your unique endpoint URL.

2. Your Endpoint

Your endpoint will look something like this:

https://api.blocksapp.com/v1/your-unique-id

3. Using the API

Blocks uses standard HTTP methods for CRUD operations:

  • POST: Create a new record
  • GET: Retrieve a record
  • PUT: Update an existing record
  • DELETE: Delete a record

API Reference

Create a Record

POST /v1/your-unique-id
Content-Type: application/json

{
  "key": "your-key",
  "value": {
    "your": "json",
    "data": "here"
  }
}

Read a Record

GET /v1/your-unique-id/your-key

Update a Record

PUT /v1/your-unique-id/your-key
Content-Type: application/json

{
  "value": {
    "updated": "json",
    "data": "here"
  }
}

Delete a Record

DELETE /v1/your-unique-id/your-key

Security

Blocks takes security seriously. Make sure to keep your endpoint URL confidential, as it acts as your API key.