DOCSEARCHbyAlgolia
Submit Docs

BackBone API Documentation

website·Indexed 30 days ago

https://docs.backbone.tools

Developer documentation for BackBone, featuring a suite of APIs for financial management (earnings, balance, cards, and refunds), commerce (products, orders, and subscriptions), CMS project and channel management, and core system authentication and logging.

Tokens
7.7K
Snippets
77
Records
80
Agent score
49%

What's inside BackBone

  1. Authenticate user (Login)

    Authenticate an existing user by sending a POST request to the login endpoint. The request body requirements are the same as the signup endpoint (email and password).
    POST https://us-central1-calm-commerce.cloudfunctions.net/api/v1/login

Request Body:
{
  "email": "user@example.com",
  "password": "yourpassword"
}

  2. Install and start the BackBine server

    Follow these steps to get the BackBine server running locally. The server will be available at http://localhost:8081/.
    # Step 1: Install Dependencies
dart pub get

# Step 2: Start the Server
dart bin/server.dart

  3. Create interactive blog posts using MDX

    Blog posts support Docusaurus Markdown features, including MDX. This allows the use of React components and JSX directly within the markdown content to create interactive elements.
    <button onClick={() => alert('button clicked!')}>Click me!</button>

  4. Manage blog posts and authors in Docusaurus

    Docusaurus blogging features are powered by the @docusaurus/plugin-content-blog plugin. To create blog posts, add Markdown files or folders to the blog directory. Authors can be managed globally in the authors.yml file. Blog post dates are automatically extracted from filenames using the format YYYY-MM-DD-title.md or by placing an index.md inside a folder named YYYY-MM-DD-title.

  6. Authenticate a user (Login)

    Authenticate an existing user by sending a POST request to the login endpoint. The request body requirements are the same as the signup endpoint (email and password).
    POST https://us-central1-calm-commerce.cloudfunctions.net/api/v1/login

  7. Set up a BackBine account and project

    To begin using BackBine, complete the following onboarding steps:

    1. Create an account: Select an account type (Developer or Company) and invite team collaborators.
    2. Start a Project: Create a project to group features and APIs, allowing for centralized data management and the use of a single access token.
    3. Enable APIs: Select the specific features and APIs required for your project.

  8. Limit blog post preview size in list view

    To limit the amount of content displayed for a blog post in the list view, insert the <!-- truncate --> HTML comment within the post content. Content appearing after this comment will be hidden in the list view and only visible on the full post page.
    This text will appear in the list view.

<!-- truncate -->

This text will only appear on the full blog post page.

  9. Disable the blog in Docusaurus

    To completely remove the blog functionality from a Docusaurus site, delete the blog directory and set the blog configuration option to false in the Docusaurus config file.
    // docusaurus.config.js
module.exports = {
  // ...
  blog: false,
};

  12. Create a new bank card

    Create a bank card by sending a POST request to /v1/cards/. If a customer ID is not provided in the request body, a new customer will be created automatically, and a customer ID will be returned in the response.
    POST /v1/cards/

{
  "customer": "string",
  "cardNumber": "4242424242424242",
  "expMonth": "8",
  "expYear": "23",
  "cvc": "567"
}