Client API Documentation

Client API Documentation

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
  }