Platform

Platform

  • Getting Started
  • API

›React Native SDK

Getting Started

  • Create Your App

Quick Starts

  • 555 Samples

Mobile SDK (v1.0)

  • Overview
  • IOS SDK

    • Getting started
    • Installation Guide
    • How to do user authentication
    • How to subscribe for notifications
    • How to initiate or accept PSTN call
    • How to initiate or accept video call
    • How to set log level for SDK
    • Release Notes

    Android SDK

    • Getting started
    • Installation Guide
    • How to do user authentication
    • How to subscribe for notifications
    • How to initiate or accept PSTN call
    • How to initiate or accept video call
    • How to set log level for SDK
    • Release Notes

Mobile SDK (v2.0)

  • Overview
  • IOS SDK

    • Getting started
    • Installation Guide
    • How to do user authentication
    • How to subscribe for notifications
    • How to initiate or accept PSTN call
    • How to initiate or accept VIDEO call
    • How to initiate or join ANONYMOUS VIDEO call
    • Release Notes
    • Reference code - How to initiate or accept PSTN Call
    • Reference code - How to initiate or accept Video Call
    • Reference code - How to initiate or join Anonymous Video Call

    Android SDK

    • Getting started
    • Installation Guide
    • How to do user authentication
    • How to subscribe for notifications
    • How to initiate or accept PSTN call
    • How to intiate or accept Video Call
    • How to intiate or accept ANONYMOUS VIDEO Call
    • Release Notes
    • Reference code - How to initiate or accept PSTN Call
    • Reference code - How to initiate or accept Video Call
    • Reference code - How to initiate or join Anonymous Video Call

    React Native SDK

    • Getting started
    • Installation Guide
    • How to do user authentication
    • How to subscribe for notifications
    • How to initiate or accept PSTN call
    • Release Notes

WebRTC JS SDK

  • Overview
  • Getting Started
  • How to do user authentication
  • How to subscribe for notifications
  • How to initialize SDK
  • How to initiate or accept PSTN call
  • How to initiate or accept video call
  • How to create a screen share session
  • Release Notes

User Authentication

Login to 555

Currently, 555 platform provides various types of authentication like login through email, facebook, CIMA token. In this document, let us look into the below options:

  • Login with Xfinity credentials
  • Login via Email
  • Anonymous Login

Login with Xfinity

  1. Use Xfinity credentials to login and get CIMA token
  2. Use AuthString from app domain created on Developer Portal and make a request to the Auth Manager to get the 555 JWT token.
Request:
  HTTP POST https://<AUTH_URL>/v1.1/login
Headers:
  Content-Type: application/json;
  Authorization: Basic <AuthString from Dev Portal>
  User-Agent: <App name>/<App version><space><System http agent>
Requestbody:
  {"type":"Cima","media_token":"<CIMA Access Token>"}

The Token that is received in the response, is a short-lived credential generated by server to authenticate the user. Response to a successful login request is given below:

Response:
  200 OK https://<AUTH_URL>/v1.1/login
  Content-Type: application/json
Responsebody:
  {"expires_in":"240","id":"<555 id>","idmapping_count":1,"token": <JWT token>,"user_data":{"cust_guid":"<customer id>","email":"<email id>"}}
  1. Using the 555 JWT token received in the Auth Manager response, make a request to the Identity manager to get the public id and routingId of the user. Routing ID is the unique Identifier for the user.
Request:
  HTTP GET https://<IDM_URL>/v1/allidentities
  Authorization: Bearer <555 JWT token>
  User-Agent: <App name>/<App version><space><System http agent>

A successful request will give us the following details as response:

Response:
  200 OK https://<IDM_URL>/v1/allidentities
  Content-Type: application/json
Responsebody:
  {"public_ids":["<user email id>","<Telephone number>","<emailId2>"],"routing_id":"<routing id of the user>"}

Keep 555 JWT Token and Routing ID handy to access the SDK APIs.

Login via Email

Login via Email involves following steps:

  1. Use 555 credentials to login
  2. Use AuthString from app domain created on Developer Portal and make a request to the Auth Manager for the 555 JWT token.
Request:
  HTTP POST https://<AUTH_URL>/v1.1/login
Headers:
  Content-Type: application/json;
  Authorization: Basic <AuthString from Dev Portal>
  User-Agent: <App name>/<App version><space><System http agent>
Requestbody:
  {"type":"Email","email":"<Registered Email ID>","password":"<Password>"}

The Token that is received in the response, is a short-lived credential generated by server to authenticate the user. Response to a successful login request is given below:

Response:
  200 OK https://<AUTH_URL>/v1.1/login
  Content-Type: application/json
Responsebody:
  {"expires_in":"<expires in>","id":"<555 id>","idmapping_count":1,"token":<555 JWT token>,"user_data":{"name":"<Name>","email":"<Registered email id>"}}
  1. Using the 555 JWT token received in the Auth Manager response, make a request to the Identity manager to get the public id and routingId of the user. Routing ID is the unique Identifier for the user.
Request:
  HTTP GET https://<IDM_URL>/v1/allidentities
  Authorization: Bearer <555 JWT token>
  User-Agent: <App name>/<App version><space><System http agent>

A successful request will give us the following details as response:

Response:
  200 OK https://<IDM_URL>/v1/allidentities
  Content-Type: application/json
Responsebody:
  {"public_ids":["<user email id>","<Telephone number>"],"routing_id":"<routing id of the user>"}""]]

Keep 555 JWT Token and Routing ID handy to access the SDK APIs.

Anonymous Login

React native SDK gives an option for the non-registered users to connect anonymously to the server, to perform a video call or chat.For this case user has to provide a random routing Id as 'user_id' to get a 555 JWT Token. A user_id or routingid can be a random uuid in the format <uuid>@<appdomain> app domain is from developer portal.

Request:
  POST https://<AUTH_URL>/v1.1/login/anonymous
  Content-Type: application/json;
  Authorization: Basic <AuthString from Dev Portal>
Requestbody:
  {"user_id":"<anonymous user id>"}

Response to a successful login request is given below:

Response:
  200 OK https://<AUTH_URL>/v1.1/login/anonymous
  Content-Type: application/json
  {"token":"<555 JWT Token>"}

Keep 555 JWT Token and Routing ID handy to access the SDK APIs.


← Installation GuideHow to subscribe for notifications →
  • Login to 555
    • Login with Xfinity
    • Login via Email
    • Anonymous Login
Docs
Getting StartedGuidesAPI Reference
More
BlogGitHub
555 Platform
Copyright © 2024 555 Platform ™
555docs-v0.0.94