(not logged in)
 
 
 
 

REST API wrappers

To install a .Net Framework REST API package and add the ASPX samples to Internet Information Services (IIS):

  • Install the .Net package for  .Net 4.0 or  .Net 4.5.2 or  .Net 4.6 or  .Net 4.6.2 to a  [local install folder]
  • From IIS Management Console:
    add new Application with Alias:  RestCSharpSamples and point it at Physical Path:  [local install folder]\Samples\C#\AppSamples
    add new Application with Alias:  RestVBSamples and point it at Physical Path:  [local install folder]\Samples\VB\AppSamples
  • Use an application pool for the ASP.NET version that matches that of the installed package and set access and authentication as required

To point your developer service at the C# SimplePlay sample:

  • Set First page to  http://[YourWebServerAddress]/RestCSharpSamples/SimplePlay.aspx
  • Set Error page to  http://[YourWebServerAddress]/RestCSharpSamples/ErrorPage.aspx

Or to point your developer service at the VB SimplePlay sample:

  • Set First page to  http://[YourWebServerAddress]/RestVBSamples/SimplePlay.aspx
  • Set Error page to  http://[YourWebServerAddress]/RestVBSamples/ErrorPage.aspx

To install the supplied Java Servlet samples in Apache Tomcat:

  • Unzip the Java package for Java 8 to a  [local install folder]
  • On Windows: Copy the contents of  [local install folder]\WEB-INF  to  \webapps\RestAPIJavaSamples\WEB-INF  under your Tomcat installation
  • On Linux: Copy the contents of  [local install folder]/WEB-INF  to  /usr/share/AculabRestAPI/RestAPIJavaSamples/WEB-INF
    Then copy the Deployment Descriptor File  [local install folder]/RestAPIJavaSamples.xml  to your Tomcat  /Catalina/localhost/ folder
  • Restart your Tomcat service

To point your developer service at the SimplePlay sample:

  • Set First page to  http://[YourWebServerAddress]:8080/RestAPIJavaSamples/SimplePlay
  • Set Error page to  http://[YourWebServerAddress]:8080/RestAPIJavaSamples/ErrorPage

To install the supplied Python wrapper and samples:

  • Unzip the  Python package to a  [local folder]
  • In  [local folder]\aculab\simple_server\rest_simple_server.py, set simple_server_host and simple_server_port to your IP address and port

To point your developer service at the simple_play sample:

  • Open a command window in  [local folder]\aculab\samples and start simple_play.py
  • Set First page for your developer number service to http://[simple_server_host]:[simple_server_port]/first_page
  • Set Final page to final_page and Error page to error_page

To install the supplied PHP samples using PEAR (see http://pear.php.net newwinOpens in new window):

  • Install the PHP package by executing:  pear install [package name or URL]
  • Find PEAR's documentation directory by running:  pear config-get doc_dir
  • Copy the AculabTelephonyRestAPI directory from PEAR's documentation directory to your web server's document root

To point your developer service at the simple_play sample:

  • Set First page to http://YourWebServerAddress/AculabTelephonyRestAPI/samples/simple_play/First.php
  • Set Error page to http://YourWebServerAddress/AculabTelephonyRestAPI/samples/common/Error.php
  • Set Final page to http://YourWebServerAddress/AculabTelephonyRestAPI/samples/common/Final.php

To install the supplied Ruby wrapper and samples:

  • Install Gem and rack and json gems onto your Ruby installation
  • Save the  Ruby package to a  [local folder]
  • Install the Aculab REST Gem: gem install aculab_rest from your  [local folder]

To point your developer service at the simple_play sample:

  • Navigate to the Aculab Gem installation directory. This can be found using gem env
  • Open a console in the  examples directory
  • Edit  base_application.rb to set the required port (default 80)
  • Set First page for your developer number service to http://[host]:[port]/my_first_page
  • Set Final page to my_ final_page and Error page to my_final_page
  • Run simple_server.rb