Web Service URL Structure

SmartSubscribe has two roots for its web services:

  • the svc root (http://<domain>/svc/...) comprises the full services, protected by authentication, both private and public APIs
  • the trial root (http://<domain>/trial/...) is used to offer trial versions of SmartSubscribe services, for general use without authentication. These services are often limited versions, mostly with quantity restrictions.

Full services with authentication

The public API for customers has several versions and groups:

The version 1 interface is deprecated and uses the following conventions:

  • resources below .../svc/address deal with the analysis of e-mail addresses
  • resources below .../svc/info provide detailed information about various entities (providers, companies, lists …). These services are rarely called on their own, most often address services reference them in their results, and let the user decide whether they need the details or not.

The current interface, version 2, uses the following conventions:

  • resources below .../svc/2.0/address deal with the analysis of e-mail addresses
  • resources below .../svc/2.0/info provide detailed information about various entities (providers, companies, lists …). These services are rarely called on their own, most often address services reference them in their results, and let the user decide whether they need the details or not.

There are also two groups in the private API for the management of the platform:

  • resources below .../svc/service are meant for the variuos management tasks
  • resources below .../svc/internal are not part of the regular platform management, these are special purpose services for troubleshooting etc.

The usage of the various services is regulated by user groups.

Trial services without authentication

Trial serivces are identical to their full counterparts, except for quantity restrictions. Their usage is restricted by certain quotas per day and IP address.

  • resources below .../trial/address deal with the analysis of e-mail addresses
  • resources below .../trial/info provide detailed information about various entities