Difference between revisions of "API/overview"

From Webcamwiz
Jump to: navigation, search
Line 1: Line 1:
 
+
=Overview=
== ImLive White Labels Services - Embedding Components in External Sites ==
+
 
+
'''Overview'''
+
  
 
This document describes how to embed ImLive webcam chat functionality in sites.
 
This document describes how to embed ImLive webcam chat functionality in sites.
Line 10: Line 7:
 
It should be noted that the components and APIs currently available for embedding cover a part of a full webcam chat service. For a full service, the embedding site should still redirect the users to ImLive or to an ImLive white label site.
 
It should be noted that the components and APIs currently available for embedding cover a part of a full webcam chat service. For a full service, the embedding site should still redirect the users to ImLive or to an ImLive white label site.
  
Available Functionality
+
=Available Functionality=
  
 
The following functions are available for embedding.
 
The following functions are available for embedding.
Line 16: Line 13:
 
A site can choose to integrate and embed all or a part of the available components.
 
A site can choose to integrate and embed all or a part of the available components.
  
1. Host list – returns the list and details of hosts currently online.
+
# Host list – returns the list and details of hosts currently online.
 
+
# Create user account
2. Create user account
+
# Login to user account.
 
+
# Free live chat.
3. Login to user account.
+
 
+
4. Free live chat.
+
  
'''Host list'''
+
==Host list==
  
 
The host list feed service can be used to retrieve a list of webcam hosts that is currently available to chat.
 
The host list feed service can be used to retrieve a list of webcam hosts that is currently available to chat.
Line 34: Line 28:
 
This enables the embedding site to render pages of hosts galleries.
 
This enables the embedding site to render pages of hosts galleries.
  
Full details of this service for integration is documented in the integration document “IML API - Hosts feed”.
+
Full details of this service for integration is documented in the integration document “'''''IML API - Hosts feed'''''”.
  
'''Create user account'''
+
==Create user account==
  
 
This service enables a site to register new user accounts in ImLive or a white label site.
 
This service enables a site to register new user accounts in ImLive or a white label site.
Line 42: Line 36:
 
It can be used to automatically create webcam user accounts from the user profiles in the embedding website so that existing users of the embedding site will have single-login experience and will not need to login to the webcam site separately.
 
It can be used to automatically create webcam user accounts from the user profiles in the embedding website so that existing users of the embedding site will have single-login experience and will not need to login to the webcam site separately.
  
Full details of this service for integration is documented in the integration document “IML WL API - User Account Management”.
+
Full details of this service for integration is documented in the integration document “'''''IML WL API - User Account Management'''''”.
  
'''Login to user account'''
+
==Login to user account==
  
 
This service logs into an existing webcam user account and creates a new session.
 
This service logs into an existing webcam user account and creates a new session.
Line 50: Line 44:
 
It can be used when sending a user from the embedding site to the webcam site so that the user will not need to manually login to the webcam site.
 
It can be used when sending a user from the embedding site to the webcam site so that the user will not need to manually login to the webcam site.
  
Full details of this service for integration is documented in the integration document “IML WL API - User Account Management”.
+
Full details of this service for integration is documented in the integration document “'''''IML WL API - User Account Management'''''”.
  
'''Free live chat'''
+
==Free live chat==
  
 
This is a fully functional and customizable webcam live video chat player that can be generated and embedded in the embedding site.
 
This is a fully functional and customizable webcam live video chat player that can be generated and embedded in the embedding site.
Line 58: Line 52:
 
It enables the embedding site to provide its users with free live chat service without leaving the site.
 
It enables the embedding site to provide its users with free live chat service without leaving the site.
  
'''Note:''' This player only support free chat. For private chats, the user will have to be redirected to ImLive or an ImLive white label.
+
Note: This player only support free chat. For private chats, the user will have to be redirected to ImLive or an ImLive white label.
  
Full details of this service for integration is documented in the integration document “IML WL API - Chat player generator”.
+
Full details of this service for integration is documented in the integration document “'''''IML WL API - Chat player generator'''''”.

Revision as of 16:20, 21 August 2014

Overview

This document describes how to embed ImLive webcam chat functionality in sites.

This is a high level overview of the available components and APIs that can be embedded and used. The technical details of the integration can be found in each component’s API/integration document.

It should be noted that the components and APIs currently available for embedding cover a part of a full webcam chat service. For a full service, the embedding site should still redirect the users to ImLive or to an ImLive white label site.

Available Functionality

The following functions are available for embedding.

A site can choose to integrate and embed all or a part of the available components.

  1. Host list – returns the list and details of hosts currently online.
  2. Create user account
  3. Login to user account.
  4. Free live chat.

Host list

The host list feed service can be used to retrieve a list of webcam hosts that is currently available to chat.

The service receives a set of parameters that determines the type of hosts required.

The returned list contains full details of the host, including all properties and images.

This enables the embedding site to render pages of hosts galleries.

Full details of this service for integration is documented in the integration document “IML API - Hosts feed”.

Create user account

This service enables a site to register new user accounts in ImLive or a white label site.

It can be used to automatically create webcam user accounts from the user profiles in the embedding website so that existing users of the embedding site will have single-login experience and will not need to login to the webcam site separately.

Full details of this service for integration is documented in the integration document “IML WL API - User Account Management”.

Login to user account

This service logs into an existing webcam user account and creates a new session.

It can be used when sending a user from the embedding site to the webcam site so that the user will not need to manually login to the webcam site.

Full details of this service for integration is documented in the integration document “IML WL API - User Account Management”.

Free live chat

This is a fully functional and customizable webcam live video chat player that can be generated and embedded in the embedding site.

It enables the embedding site to provide its users with free live chat service without leaving the site.

Note: This player only support free chat. For private chats, the user will have to be redirected to ImLive or an ImLive white label.

Full details of this service for integration is documented in the integration document “IML WL API - Chat player generator”.