Giter Club home page Giter Club logo

demo-ds2015-ewebrtc-sdk's Introduction

JavaScript SDK for AT&T Enhanced WebRTC API

Contents of this package

  • /js/ewebrtc-sdk.min.js: JavaScript client library for AT&T Enhanced WebRTC API
  • /node-dhs: Node DHS
  • /node-sample/: Node Sample Application
  • /node-sample/public/tutorial/index.html: AT&T's Enhanced WebRTC Javascript SDK tutorial
  • /node-sample/public/api-docs/index.html: JS SDK API reference documentation

Using the Sample Application

This is a guide to setup AT&T's Enhanced WebRTC sample application. The sample application can be used as a reference so that developers may learn from and build their own applications based on it.

Summary

  • Enroll in the AT&T Developer program
  • Create your application in the developer portal and generate application key/secret.
  • Configure the Node DHS using your application key/secret generated above as well as some additional configuration (see below).
  • Configure the Node Sample Application with your DHS URL
  • Install the Node DHS dependencies: Run $ npm install in the node-dhs directory.
  • Install the Node Sample Application dependencies: Run $ npm install in the node-sample directory.
  • Start the DHS: Run $ npm start from the node-dhs directory
  • Start the Sample Application: Run $ npm start from the node-sample directory
  • Launch browser to run the sample application: https://localhost:9001/

1. Enrolling and Creating your Enhanced WebRTC Application.

Before you can access the AT&T Platform services, you must enroll in AT&T's Developer Program, then register your application for the services that you want to access and to get an API key and secret key. These keys are necessary to call the underlying AT&T RESTful APIs that access the services.

1.1. Enrolling in the Developer Program

  1. Create a new developer account on the AT&T Developer program, or login to an existing account.
  2. Request Premium Access for your account from the CTS Middleware Data Team.

1.2. Creating your own Enhanced WebRTC application

Prerequisite: An AT&T Developer Account with Premium Access

Perform the following steps to register an application:

  1. Sign In to your AT&T Developer Account created in the previous section.
  2. Go to Manage my Account
  3. Select My Apps from the bar at the top of the page (right-most orange button).
  4. Click Setup a New Application
  5. Chose the scope: Enhanced WebRTC & In App Calling (displaying the AT&T user's phone number) from the list.

After your application is registered, you have an API Key and Secret key. These keys are necessary to get your applications working with the AT&T Platform APIs.

2. Installing System Requirements

Refer to the online documentation to install these dependencies for your system.

3. Configure & Run the Node DHS

  • Refer to: /node-dhs/README.md for details on the DHS's features and setup instructions.
  • Refer to: /node-dhs/RELEASE.md for the latest Release Notes and information about known issues, workarounds, etc.

4. Configure & Run the Node Sample Application

Notes

  • The Node Sample Application uses the DHS for its initial configuration. It sets up:
  • Enhanced WebRTC API Endpoint,
  • DHS RESTful API

5. Acronyms and Terminology

  • API: Application Programming Interface
  • GA: General Availability
  • DHS: Developer Hosted Server
  • JS: JavaScript
  • SDK: Software Development Kit
  • WebRTC: Web Real-Time Communications, a W3C standard

demo-ds2015-ewebrtc-sdk's People

Watchers

James Cloos avatar Ramo Theonly avatar Surender Mohan avatar Nishita Mohan avatar

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.