Provisioning API
(Last Updated On: August 16, 2017)

Overview

The SnapEngage Provisioning REST API provides a method for 3rd parties to perform the following:

  • Create a new user account
  • Get existing user account details
  • Update an existing user account
  • Find out if a user account exists
  • Delete an existing user account
  • Create a Widget and add to existing user account

Note: All API requests require the use of HTTPS


API Key

A valid key is required to use the Provisioning REST API. Please contact us if you need to obtain an api key.


User Request Data Format

The REST API accepts requests in both JSON and XML formats. To specify, use the appropriate format: json or xml. For instance:

JSON User format
{
	'email' : 'value',
	'name' : 'value',
	'password' : 'value',
	'phone' : 'value',
	'accountType' : 'value'
}
XML User format
<!--?xml version='1.0' encoding='UTF-8'?-->
	value
	value
	value
	value
	value
User data fields

Required, a valid email address less than 100 characters

– Valid name less than 100 characters

– Valid password between 5 and 100 characters

– Valid telephone number

– Type of account, from the following:

See our plans page for more details http://www.snapengage.com/plans?all


Create a new user account


Get user account details or check if user exists

Get existing user account details if created with same api key, Otherwise a check if user exists


Update an existing user account


Delete an existing user account


Widget Request Data Format

The REST API accepts requests in both JSON and XML formats. To specify, use the appropriate format: json or xml. For instance:

JSON Widget format
{
   'email':'account email address',
   'destinationEmail':'email where transcripts are sent',
   'name':'widget name',
   'agents':[
      {
         'agentId':'agent id',
         'agentAlias':'agent displayed name',
         'agentAvatar':'link to agent image - 53x53px is recommended size',
         'agentType':'either google, skype, or webclient'
      }
   ],
   'onlineButtonUrl':'link to online button',
   'offlineButtonUrl':'link to offline button',
   'enableProactiveChat':'true/false',
   'proactiveSettings':[
      {
         'delayInSec':'time in sec - 45 is default',
         'enableSound':'true/false - default is true',
         'urlRule':'url rule - default is http*://*, matching all pages',
         'message':'proactive message - default is Hello, How can I assist you today?'
      }
   ]
}
XML User format
Coming soon...
Widget data fields

– Required, existing user account email address

– Valid name less than 100 characters

– Public UUID of Widget


Create a new Widget



Get widget details



Update an existing widget



Delete an existing widget