Skip to content

Magicbooks-io/.github

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

39 Commits
 
 
 
 
 
 

Repository files navigation

Magicbooks.io Rewarded Book Preview API

329283891_1248377109084261_2911143365785344954_n.mp4

Something magical happens when humans are rescued from the endless scrolling feeds of social media and brought into the simple and ancient book-like format. Add music and media, create a pivotal role for the great developers of the world, and this project which started as a shot towards the 'unreachable star' gets very interesting. What is outlined here is a quick view of the engine.

The Magicbooks.io API hopes to create a vast new income stream for developers and bloggers by making it easy for ordinary people to monetize with rewarded book previews while creating a better way for authors and creators to monetize books and any valuable content.

MagicBooks API Documentation

Introduction

Welcome to the MagicBooks API, a platform that allows third-party developers to integrate rewarded book previews and contribute data to strengthen the book chain.

Table of Contents

  1. Introduction
  2. Getting Started
  3. Creating Book Sessions
  4. Monetizing with Rewarded Book Previews
  5. Contributing Data
  6. Examples

Introduction

MagicBooks.io API allows game and app developers, bloggers, and website owners to integrate rewarded book preview ads into mobile applications and websites.

Rewarded Book Preview Ads is a new category of rewarded ad format which includes multiple goal-oriented delivery-methods and strategies.

For example:

  • 1. Authors can monetize digital books by allowing readers to read a preview, then direct the reader to purchase a book or allow them to continue reading in exchange for viewing a relavent and data-driven advertisement. Advertisers purchase ad slots, pay for each verified engagement, can opt into paying commissions for sales and/or elect custom strategies based on the advertising goals. The author or creator of the magicbook earns 100% of this direct ad-revenue and can elect to share said revenue with third-party developers who display the magicbook and ads, contribute ephemereal data to the book chain to improve targeting, and enhance engagement and ad-displays through skilled ux design and creativity.
  • Note: Our studies show authors and creators can viably earn many times the amount they would for a book under the primitive model of only buying and selling books; and developers can earn many-times more than with adsense or comparable global ad-networks, while continuing to utilize any ad-server with the freedom all developers should enjoy.

  • 2: Businesses can create product catalogs, whitepapers, and any content-oriented marketing, setting per click bids and real-time header bidding.
  • 3:Developers can sell and mediate first-party ads, earn for contributing valuable data to the decentralized bookChain, and participate in the development and growth of a new method and channel for online advertising while creating a source of wealth controlled by ordinary people, authors, creators, educators, musicians, and developers, free from harch censorship and poised to attract a new generation of small businesses embracing the creator-driven online ad market.

    Getting Started

    API Endpoint

    The base API endpoint for all Magicbooks.io api calls is:

    https://api.magicbooks.io/{endpoint}

    Authentication

    To use the API, include the following parameters in the URL:

    • appId: Unique identifier for the developer's application.
    • key: API key associated with the provided appId.

    Retreiving A List of Books

    Request

    Make a GET request to the below endpoint with the required parameters:

    GET https://api.magicbooks.io/getBooks?appId=[appid-string]&key=[apikey-string]

    Response

    The API will respond with a JSON object containing the following information:

    • books: Array containing published book objects.

    • {
                  "id": "BmGUwGXVQlUnBPvAFRe8",
                  "title": "Magicbooks.io For Smarthomes",
                  "author": "Magicbooks4Smarthomes",
                  "coverImage": "https://res.cloudinary.com/wikacy-com/image/upload/v1688345016/book-covers/smacdoubovpvy1srvvhl.jpg"
              }

      Display the books however you like. Members can create, sell, and monetise all kinds of templates, interactions, automations, and plugins to extend the value of each book app/channel.

    • Information regarding prior bookSessions, first-party ads, bid-amount, payout amounts, top-performing books, ad-slot-trading, and user-keys(ephemereal) can be configured by each developer by contributing to the bookChain(see documentation in Magicbooks.io for more details)

    Creating Book Sessions

    Request

    Add a click-event listener to each item to trigger e a GET request to the API endpoint with the below parameters:

    GET https://api.magicbooks.io/bookSession/create?appId=[appid-string]&key=[apikey-string]&=bookId=[bookId-string]

    Response

    The API will respond with a JSON object containing the following information:

    • bookSessionId: Unique identifier for the created book session.
    • bookId, adId, advertId, category, userId: Information about the book session.
    • loadUrl: URL to load the rewarded book preview.

    (see also the Magicbooks-API NPM Package

    Monetizing with Rewarded Book Previews

    Developers can monetize applications by displaying the rewarded book previews loaded from the provided URL. Users will be rewarded for engaging with these previews in multiple ways, and all session events are logged and made available via the sessionEvents/{sessionId} endpoint as well as a Magicbooks.io Developers Dashboard

    Examples

    Creating a Book Session

    Sample JavaScript code to create a book session:

       const fetch = require('node-fetch');
       const appId = 'developerAppId';
       const apiKey = 'developerApiKey';
    

    fetch(https://api.magicbooks.io/bookSession/create?appId=${appId}&key=${apiKey}) .then(response => response.json()) .then(data => console.log(data)) .catch(error => console.error(error));

    Developers Selling and Managing Ads

    One unique feature of MagicBooks API is the singular feature which allows developers to take full control of the advertising strategy. By submitting the advertId and adId parameters, developers can:

    • Create and sell their own ads directly through the API.
    • Generate dynamic ads using the ad/create endpoint.
    • Sign up new advertisers using the advertiser/create endpoint.
    • Access the whitelabeled ad portal to manage creatives, products, brand guidelines, and analyze campaign results.

    Developers have the flexibility to:

    • Collect independent payments for their ads.
    • Write their own rules and guidelines governing earnings for contributors to the display and engagement with first-party ads.
    • Production members can configure their app to provide an advertising client-portal, sell ads, buy and sell ad slots, and much more.

    Get Involved in Personalization and Segmentation

    We encourage developers to get involved and unite behind a way to personalize and segment users without jeopardizing their privacy or exposing their identity.

    Create An App

    Setup and Display a Book Feed On Any Site

    scrnli_2_5_2024_9-07-42 PM scrnli_2_5_2024_9-07-11 PM

    Simple and unobtrusive promos can be displayed between pages, on pages, or in any slot you or the bookChain create. Earn commissions on book sales, products, and promote your own clients, music partners, or anything in a manner which enhances focus and is proven to greatly increase roi. Authors can write books and allow readers to enjoy them for free and earn far more than they ever could under the old primitive model of buying and selling, and developers share in a vast new market and sustain a better way for businesses to connect with consumers.

    web-feed-demo.mp4

    Untitled design - 2023-11-11T220241 282 -->

    Third Party Apps/Websites


    Huawei-P30-PRO-localhost (6)

    Huawei-P30-PRO-localhost (7)

About

Magicbooks.io Rewarded Book Preview API

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published