SOAP Services v1

SOAP Services v1

Getting Started Using the Urchin Data API Web Services

API Table of Contents

To use the Urchin Data API, write a client program in the language of your choice (such as Java, .Net, Perl, Python, C, C++, PHP).

The client program sends a request to one of the Urchin data web services, such as adminservice or reportservice. The relevant service processes the request and sends back a response which the client program must parse. To use the API, you'll only need to install the software for the language and toolkit that you will be using to write your client programs. So, for example, if you intend to write your client programs in Java with SOAP, you will need to install Java and a SOAP toolkit such as Axis.

Web Services Overview

The operations provided by a web service are defined in a WSDL file. Before connecting to a web service, you need to know the URL that points to its WSDL file. Each Urchin Data API web service has its own WSDL. The URL for each WSDL has the following form, where SERVER_NAMEPORT is the server name and port running the Urchin web application, N is the version number and SERVICE_NAME is the service name:

 

https://SERVER_NAME[:PORT]/services/vN/SERVICE_NAME?wsdl

For example, this is the URL for the v1 adminservice WSDL:

 

http://yourhost/services/v1/adminservice?wsdl

and this is the URL for the v1 reportservice WSDL:

 

http://yourhost/services/v1/reportservice?wsdl

The following methods of Urchin Data API Web Services are defined in a WSDL file:

  • Admin service (see Admin service (SOAP) v1)

    • o getAccountList
      • The getAccountList method lets you extract accounts information for an authenticated user.
      o getProfileList
      • The getProfileList method lets you extract profile information for an authenticated user.
  • Report service (see Report service (SOAP) v1)

    • o getTableList
      • The getTableList method lets you extract table information for a specified profile.
      o getData
      • The getData method lets you extract data from Urchin.