Backpulse

Headless CMS built with ❤.

Jump to documentation

What it is

Backpulse.io is an open source API Based / Headless CMS.
Manage your site's content through Backpulse's interface and retrieve it with a secure API.

@backpulse on GitHub.

Features

• Unlimited sites
• Storage
• API endpoint encrypted with a Cloudflare SSL certificate
• Contribution
• Easy to use
• Dark theme

Examples

My blog is powered by Backpulse.io. Check it out

GitHub source

Donate

Please consider donating if you think Backpulse is helpful to you or that my work is valuable.
I would be very grateful!

Contribute

All contributions are welcome!

backpulse/core built with Go
backpulse/dashboard built with React
backpulse/frontpulse built with React

Documentation

Welcome to Backpulse's documentation!

Getting started

Your API Endpoint is : https://api.backpulse.io/:sitename.
Where :sitename is your site's name.

Exemple of a successful request:

{
    "status": "success",
    "code": 200,
    "message": "success",
    "payload": {}
}

Exemple of a 404 (not found) error:

{
    "status": "error",
    "code": 404,
    "message": "not_found",
    "payload": null
}

Routes

List of all available routes for the client api.

About

Fetch about informations

GET /about

Response:

{
    "status": "success",
    "code": 200,
    "message": "success",
    "payload": {About}
}

Contact

Fetch contact informations

GET /contact

Response:

{
    "status": "success",
    "code": 200,
    "message": "success",
    "payload": {Contact}
}

Articles

• Fetch all articles of site.

  GET /articles

  Response:

  {
      "status": "success",
      "code": 200,
      "message": "success",
      "payload": []Article
  }

• Fetch specific article.

  GET /articles/:shortid

  Response:

  {
      "status": "success",
      "code": 200,
      "message": "success",
      "payload": Article
  }

Galleries

• Fetch all galleries of site.

  GET /galleries

  Response:

  {
      "status": "success",
      "code": 200,
      "message": "success",
      "payload": []Gallery
  }

• Fetch specific gallery.

  GET /gallery/:shortid

  Response:

  {
      "status": "success",
      "code": 200,
      "message": "success",
      "payload": Gallery
  }

• Fetch default gallery.

  GET /galleries/default

  Response:

  {
      "status": "success",
      "code": 200,
      "message": "success",
      "payload": DefaultGallery
  }

Projects

• Fetch all projects of site.

  GET /projects

  Response:

  {
      "status": "success",
      "code": 200,
      "message": "success",
      "payload": []Project
  }

• Fetch specific project.

  GET /projects/:shortid

  Response:

  {
      "status": "success",
      "code": 200,
      "message": "success",
      "payload": Project
  }

Albums

• Fetch all albums of site.

  GET /albums

  Response:

  {
      "status": "success",
      "code": 200,
      "message": "success",
      "payload": []Album
  }

• Fetch specific album.

  GET /albums/:shortid

  Response:

  {
      "status": "success",
      "code": 200,
      "message": "success",
      "payload": Album
  }

• Fetch specific track.

  GET /tracks/:shortid

  Response:

  {
      "status": "success",
      "code": 200,
      "message": "success",
      "payload": Track
  }

Video groups

• Fetch all video groups of site.

  GET /videogroups

  Response:

  {
      "status": "success",
      "code": 200,
      "message": "success",
      "payload": []VideoGroup
  }

• Fetch specific video group.

  GET /videogroups/:shortid

  Response:

  {
      "status": "success",
      "code": 200,
      "message": "success",
      "payload": VideoGroup
  }

• Fetch specific video.

  GET /videos/:shortid

  Response:

  {
      "status": "success",
      "code": 200,
      "message": "success",
      "payload": Video
  }