Skip to main content

Getting Started

To start building with BackBine you will need to setup your account, project and enable the APIs you are intrested in using.

Here are the steps you will need to take

Create an account​

  • choos an account type, are you a developer or a company?
  • invite your team or collaborators

Start a Project​

group all your features and API into one place you can manage all data and use a single access token

Enable APIs​

Choose the features you want to use within your project

📘 API Guide

A guide to running the server and sending POST, GET, PUT, PATCH, and DELETE requests to Projects, Collections, and Clients.

🔧 Step 1: Install Dependencies​

dart pub get

▶️ Step 2: Start the Server​

dart bin/server.dart

השרת ירוץ בכתובת:

http://localhost:8081/

📚 Collections​

➕ Add Collection (POST)​

POST http://localhost:8081/collections

Headers​

KeyValue
Content-Typeapplication/json

Body​

{
  "name": "Customer Data",
  "description": "Collection of customer records",
  "numberOfClients": 10,
  "numberOfUsers": 300,
  "usage": "Production",
  "pricing": 999,
  "endpoints": [101, 102, 103]
}

Response​

{
  "message": "Collection created",
  "id": "682eed1bf817dc2357000001"
}

📚 Collections​

➕ Add Collection (POST)​

POST http://localhost:8081/collections

Headers​

KeyValue
Content-Typeapplication/json

Body​

{
  "name": "Customer Data",
  "description": "Collection of customer records",
  "numberOfClients": 10,
  "numberOfUsers": 300,
  "usage": "Production",
  "pricing": 999,
  "endpoints": [101, 102, 103]
}

Response​

{
  "message": "Collection created",
  "id": "682eed1bf817dc2357000001"
}

📥 Get All Collections (GET)​

GET http://localhost:8081/collections

Response​

[
  {
    "_id": "682eed1bf817dc2357000001",
    "name": "Customer Data",
    "description": "Collection of customer records",
    "numberOfClients": 10,
    "numberOfUsers": 300,
    "usage": "Production",
    "pricing": 999,
    "endpoints": [101, 102, 103],
    "createdAt": "...",
    "deletedAt": null
  }
]

🔍 Get Collection by ID (GET)​

GET http://localhost:8081/collections/{id}

Response​

{
  "_id": "682eed1bf817dc2357000001",
  "name": "Customer Data",
  "description": "Collection of customer records",
  ...
}

✏️ Update Collection (PUT)​

PUT http://localhost:8081/collections/{id}

Body​

{
  "name": "Updated Collection",
  "usage": "Internal only"
}

Response​

{
  "message": "Collection updated"
}

💤 Soft Delete Collection (PATCH)​

PATCH http://localhost:8081/collections/{id}/soft-delete

Response​

{
  "message": "Collection soft-deleted"
}

🗑️ Hard Delete Collection (DELETE)​

DELETE http://localhost:8081/collections/{id}

Response​

{
  "message": "Collection hard-deleted"
}