License Addon API

From Sohowiki
(Difference between revisions)
Jump to: navigation, search
(API Script URL to hit)
 
Line 10: Line 10:
 
You can pass these to the api script via GET or POST — Your choice.
 
You can pass these to the api script via GET or POST — Your choice.
  
===Descriptions===
 
 
{|  
 
{|  
 
! parameter name  
 
! parameter name  
Line 36: Line 35:
 
| The domain name of the website (or host name of server) you want to license this addon for. Do not include "http://" or "www.". Both will be stripped. All lower-case preferably buy case is forced to lower anyway by api.
 
| The domain name of the website (or host name of server) you want to license this addon for. Do not include "http://" or "www.". Both will be stripped. All lower-case preferably buy case is forced to lower anyway by api.
 
|}
 
|}
 +
 +
==Responses==
 +
API will output "success" or an error message.

Latest revision as of 23:38, 15 February 2007

This API is designed to allow plugin and template developers to automate the process of issuing licenses for plugins and templates they develop...like if they have to install one of their own addons on a bunch of sites and don't want to have to manually generate a license for each addon on each domain via the Soholaunch Addons > Manage Account > My Licenses > Test Licenses.

API Script URL to hit

http://addons.soholaunch.com/api/license_addon.api.php

Note: https:// will work too. Your choice.

https//addons.soholaunch.com/api/license_addon.api.php

Required variables/parameters to pass

You can pass these to the api script via GET or POST — Your choice.

parameter name example value description
email bob@example.com Email address you use to log-in to your Soholaunch Addons account (the account that 'owns' the addon you're trying to license).
password superB0b1 Password address you use to log-in to your Soholaunch Addons account.
addon_folder QUICKEDIT_DROPDOWN or AGRICULTURE-FarmSickle-Vertical_Menu If licensing a plugin, this is should be the name of your plugin folder. If licensing a template, this should be the name of your template folder.
license_type "domain" or "server" Set to "domain" if issuing a license of a single domain or "server" if issuing a license for an entire web server.
license_domain example.com or server.example.com The domain name of the website (or host name of server) you want to license this addon for. Do not include "http://" or "www.". Both will be stripped. All lower-case preferably buy case is forced to lower anyway by api.

Responses

API will output "success" or an error message.

Personal tools