Giter Club home page Giter Club logo

cee-publisher-service's Introduction

C2E Publisher Service Setup Guide

Please execute the folowing commands before starting the App for the first time.

npm install

npm run migrate

npx sequelize-cli db:seed:all

npm start

C2E Publisher Service API Documentation (Open API Specification)

Welcome to the Curriki C2E Publisher Service API documentation. 🎉 🎉 🎉

Table of Contents

Base URL

All endpoints are relative to the base URL:

https://service-host/api/v1

Authentication

API Key

All endpoints require an x-api-key header for authentication. Different roles have different API keys for access.

C2E Routes

Publish C2E

Endpoint to publish C2E with required entities.

  • URL: /c2e/publish
  • Method: POST
  • Summary: Publish C2E (called from publisher tool)
  • Consumes: application/json
  • Produces: application/json
  • Parameters:
    • x-api-key (header) - C2E Publisher Service API Key
      • Type: string
      • Default: APIKey (role: cee-publisher-tool)
      • Required: true
    • payload (body) - C2E entity details
  • Responses:

    • 200:

      • Schema: 
        {
  "code": 200,
  "message": "Success",
  "result": true
}

    • 400:

      • Schema: 
        {
  "code": 400,
  "message": "Invalid request payload",
  "result": false
}

PublishC2ERequest

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "C2E Title (which would be the as Educational Experience Title)"
    },
    "description": {
      "type": "string",
      "description": "C2E Description (which would be the as Educational Experience description)"
    },
    "creator": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "description": "C2E Creator Name"
        },
        "email": {
          "type": "string",
          "description": "C2E Creator Email"
        }
      }
    },
    "storeId": {
      "type": "string",
      "description": "Unique identifier of the store"
    },
    "workflowItems": {
      "type": "array",
      "items": {
        "$ref": "#/definitions/C2EWorkflowItem"
      }
    }
  }
}

workflowItems payload object "#/definitions/C2EWorkflowItem" would be defined as array of following type of objects:

C2EWorkflowItem

   "C2EWorkflowItem": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "description": "Educational Experience Title"
        },
        "description": {
          "type": "string",
          "description": "Educational Experience description"
        },
        "type": {
          "type": "string",
          "description": "Type of the workflow item (e.g., Educational Experience)"
        },
        "subject": {
          "type": "array",
          "items": {
            "type": "string",
            "description": "Educational Experience Subjects"
          }
        },
        "educationLevel": {
          "type": "array",
          "items": {
            "type": "string",
            "description": "Educational Experience Education Levels"
          }
        },
        "keywords": {
          "type": "array",
          "items": {
            "type": "string",
            "description": "Educational Experience Keywords"
          }
        },
        "url": {
          "type": "string",
          "description": "Educational Experience C2E Protected URL"
        },
        "thumbnailUrl": {
          "type": "string",
          "description": "Educational Experience Thumbnail URL"
        },
        "media": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/C2EMedia"
          }
        }
      }
    }

C2EMedia payload object "#/definitions/C2EMedia" would be defined as array of following type of objects:

C2EMedia

"C2EMedia": {
      "type": "object",
      "properties": {
        "identifier": {
          "type": "string",
          "description": "Identifier for the media"
        },
        "identifierType": {
          "type": "string",
          "description": "Type of identifier (e.g., ISBN, DOI, URL, UUID, other)"
        },
        "name": {
          "type": "string",
          "description": "Name of the media"
        },
        "description": {
          "type": "string",
          "description": "Description of the media"
        },
        "resource": {
          "type": "string",
          "description": "Media URL or source identifier for the media"
        },
        "encodingFormat": {
          "type": "string",
          "description": "Encoding format of the media (e.g., video/mp4)"
        },
        "royalty": {
          "$ref": "#/definitions/C2EMediaRoyalty"
        },
        "owner": {
          "type": "object",
          "properties": {
            "name": {
              "type": "string",
              "description": "C2E Media Owner Name"
            },
            "email": {
              "type": "string",
              "description": "C2E Media Owner Email"
            }
          }
        }
      }
}

Create C2E Manifest

Endpoint to create C2E Manifest.

  • URL: /c2e/manifest
  • Method: POST
  • Summary: Create C2E Manifest (called from store service)
  • Consumes: application/json
  • Produces: application/json
  • Parameters:
    • x-api-key (header) - API Key
      • Type: string
      • Default: APIKey (role: cee-store-service)
      • Required: true
    • payload (body) - C2E Manifest Data
  • Responses:

    • 200:

      • Schema: 
        {
  "code": 200,
  "message": "Success",
  "result": true
}

    • 400:

      • Schema: 
        {
  "code": 400,
  "message": "Invalid request payload",
  "result": false
}

CreateC2EManifestRequest

{
  "type": "object",
  "properties": {
    "ceeId": {
      "type": "string",
      "description": "C2E Id (which has already been created in C2E Publisher Service)"
    },
    "previewCeeSubscription": {
      "type": "object",
      "properties": {
        "ceeListingId": {
          "type": "string",
          "description": "C2E Listing Id (which has already been created in C2E Store Service)"
        },
        "type": {
          "type": "string",
          "description": "C2E Subscription Type (e.g., preview) (which has already been created in C2E Store Service)"
        },
        "licenseType": {
          "type": "string",
          "description": "C2E License Type (e.g., Creative Commons) (which has already been created in C2E Store Service)"
        },
        "licenseTerms": {
          "type": "string",
          "description": "C2E License Terms (which has already been created in C2E Store Service)"
        },
        "amount": {
          "type": "string",
          "description": "C2E Subscription Amount (which has already been created in C2E Store Service)"
        },
        "currency": {
          "type": "string",
          "description": "C2E Subscription Currency (e.g., USD) (which has already been created in C2E Store Service)"
        },
        "copyrightNotice": {
          "type": "string",
          "description": "C2E Subscription CopyRight Notice (which has already been created in C2E Store Service)"
        },
        "license": {
          "type": "string",
          "description": "C2E Subscription License (which has already been created in C2E Store Service)"
        },
        "clientId": {
          "type": "string",
          "description": "C2E Subscription Client Id (which is assoicated with Player Service and has already been created in C2E Store Service)"
       

 }
      }
    },
    "licensedCeeSubscription": {
      "type": "object",
      "properties": {
        "ceeListingId": {
          "type": "string",
          "description": "C2E Listing Id (which has already been created in C2E Store Service)"
        },
        "type": {
          "type": "string",
          "description": "C2E Subscription Type (e.g., licensed) (which has already been created in C2E Store Service)"
        },
        "licenseType": {
          "type": "string",
          "description": "C2E License Type (e.g., Creative Commons) (which has already been created in C2E Store Service)"
        },
        "licenseTerms": {
          "type": "string",
          "description": "C2E License Terms (which has already been created in C2E Store Service)"
        },
        "amount": {
          "type": "string",
          "description": "C2E Subscription Amount (which has already been created in C2E Store Service)"
        },
        "currency": {
          "type": "string",
          "description": "C2E Subscription Currency (e.g., USD) (which has already been created in C2E Store Service)"
        },
        "clientId": {
          "type": "string",
          "description": "C2E Subscription Client Id (which is assoicated with Player Service and has already been created in C2E Store Service)"
        }
      }
    }
  }
}

Get C2E Stream Token

Endpoint to get a C2E Stream token.

  • URL: /stream/token
  • Method: GET
  • Summary: Get C2E Stream token (called from store service)
  • Parameters:
    • x-api-key (header) - Authentication and Authorization
      • Type: string
      • Default: APIKey (role: cee-store-service)
      • Required: true
    • subid (query) - C2E Subscription ID setup on the store service
      • Type: string
      • Required: true
  • Responses:
    • 200:
      • Description: Success
      • Schema: 
        {
  "code": 200,
  "message": "Success",
  "result": [
    {
      "ceeId": "C2E ID",
      "token": "C2E Stream Token",
      "expiresAt": "C2E Stream Token Expiry Date"
    }
  ]
}

Verify C2E Stream Token

Endpoint to verify a C2E Stream token.

  • URL: /stream/token/verify
  • Method: GET
  • Summary: Verify C2E Stream token (called from publisher service)
  • Parameters:
    • x-api-key (header) - Authentication and Authorization
      • Type: string
      • Default: APIKey (role: cee-publisher-tool)
      • Required: true
    • ceeId (query) - C2E ID
      • Type: string
      • Required: false
    • token (query) - Token
      • Type: string
      • Required: true
  • Responses:
    • 200:
      • Description: Success
      • Schema: 
        {
  "code": 200,
  "message": "Success",
  "result": [
    {
      "valid": true | false
    }
  ]
}

Get C2E Manifest

Endpoint to get a C2E Manifest.

  • URL: /stream/manifest
  • Method: GET
  • Summary: Get C2E Manifest (called from store service)
  • Parameters:
    • x-api-key (header) - Authentication and Authorization
      • Type: string
      • Default: APIKey (role: cee-store-service)
      • Required: true
    • subid (query) - C2E Subscription ID
      • Type: string
      • Required: true
  • Responses:
    • 200:
      • Description: Success
      • Schema: 
        {
  "code": 200,
  "message": "Success",
  "result": [
    {
      "ceeId": "C2E Subscription ID",
      "manifest": "C2E Manifest"
    }
  ]
}

C2E Store Routes

Get C2E Stores

Endpoint to retrieve C2E Stores (called from publisher tool).

  • URL: /c2e-stores
  • Method: GET
  • Summary: Get C2E Stores (called from publisher tool)
  • Parameters:
    • x-api-key (header) - Get C2E Stores
      • Type: string
      • Default: APIKey (role: cee-publisher-tool)
      • Required: true
  • Responses:

    • 200:

      • Schema: 
        {
  "code": 200,
  "message": "Success",
  "result": [
    {
      "id": "C2E Store ID",
      "name": "C2E Store Name"
    }
  ]
}

API Key Routes

Get API Keys

Endpoint to retrieve API Keys.

  • URL: /keys
  • Method: GET
  • Summary: Get API Keys
  • Parameters:
    • Authorization (header) - Authorization
      • Type: string
      • Default: Bearer APIKey
      • Required: true
  • Responses:

    • 200:

      • Schema: 
        {
  "code": 200,
  "message": "Success",
  "result": [
    {
      "key": "APIKey",
      "clientRole": "cee-publisher-tool | cee-store-service",
      "clientEmail": "[email protected]"
    }
  ]
}

Swagger Documentation

Swagger Documentation can be found on following link https://service-host/api-docs/

Database Diagram

db

This README provides a comprehensive overview of the Curriki C2E API endpoints, their functionalities, required parameters, and expected responses. For more detailed information, refer to the OpenAPI spec or the API implementation.

Please replace the placeholders such as <Base URL> with your actual API base URL.

Feel free to reach out if you have any questions or need further clarification.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.