phpLedMailer Install Guide
Documentation Index

phpLedMailer as a Web Service
Beginning with version 1.8, phpLedMailer included the ability to consume the subscribers details (add, remove and pull existing subscriber details) through a SOAP interface. This is extremely useful in situations where outside applications need to interact with phpLedMailer's data. Some example applications that could use this:

• Import/Export Utility
  A utility that allows the user to import/export massive amounts of users (which the current interface is not designed for)
• Remote Administrator
  A client (perhaps a windows client) to allow an administrator to add/edit/delete subscriber details.
• Integration with existing site
  Instead of forcing the developer of a site to work directly with the database to integrate phpLedMailer with their site backend, simply build a SOAP interface to phpLedMailer and let it continue to work directly with the database. This means that you can have cross-site mailing list signups (completely transparent to the user, as it would happen on the backend) and complete integration of the user lists into the sites administrative control panel.

These are just a few ideas... the sky is truly the limit!

Implementing phpLedMailer services.
To use phpLedMailer's services functionality, you must explicitly configure it (disable by default, for security). Follow the following steps to enable and consume the web services:

1. Make sure you're at phpLedMailer version 1.8 (or higher)
2. Under the configuration menu, check the "Enable webservice?" checkbox, and enter a key for the "Web Service Key". This key can be anything you want, up to 32 characters. To randomly generate a key, click the 'Generate' link. This is a javascript method which will create a completely random key for you. Save these configuration changes.
3. You can now consume the web services. The location of the service (URL) is simply the path to the phpLedMailer directory, plus a '/service/' directory. For example, if you have phpLedMailer installed at http://yoursite.com/phpLedMailer/ then the web service interface would be http://mysite.com/phpLedMailer/service/
   
   You can load this in your web browser to view the methods and input/output values of each method.
4. Write an application that consumes the webservices! That's it!
   We have included a few sample applications that make use of phpLedMailer's services functionality. You can find out more information about them here:
   phpLedMailer as a Service Samples
   

Copyright Ledscripts.com 2005