{eac}SoftwareRegistry Distribution\n<\/p>","2":"
UI Example 1 (Activate\/Register):\n<\/p>","3":"
UI Example 2 (Refresh\/Delete):\n<\/p>"},"jetpack_post_was_ever_published":false},"plugin_section":[],"plugin_tags":[146554,212051,26437,211904,211995],"plugin_category":[],"plugin_contributors":[211905],"plugin_business_model":[],"class_list":["post-160080","plugin","type-plugin","status-publish","hentry","plugin_tags-license-manager","plugin_tags-registration-api","plugin_tags-software-license","plugin_tags-software-registration","plugin_tags-software-registry","plugin_contributors-kevinburkholder","plugin_committers-kevinburkholder"],"banners":{"banner":"https:\/\/ps.w.org\/eacsoftwareregistry-distribution-sdk\/assets\/banner-772x250.jpg?rev=2761826","banner_2x":"https:\/\/ps.w.org\/eacsoftwareregistry-distribution-sdk\/assets\/banner-1544x500.jpg?rev=2761826","banner_rtl":false,"banner_2x_rtl":false},"icons":{"svg":false,"icon":"https:\/\/ps.w.org\/eacsoftwareregistry-distribution-sdk\/assets\/icon-128x128.png?rev=2756288","icon_2x":"https:\/\/ps.w.org\/eacsoftwareregistry-distribution-sdk\/assets\/icon-256x256.png?rev=2756288","generated":false},"screenshots":[{"src":"https:\/\/ps.w.org\/eacsoftwareregistry-distribution-sdk\/assets\/screenshot-1.png?rev=3092463","caption":"
{eac}SoftwareRegistry Distribution\n<\/p>"},{"src":"https:\/\/ps.w.org\/eacsoftwareregistry-distribution-sdk\/assets\/screenshot-2.png?rev=3092463","caption":"
UI Example 1 (Activate\/Register):\n<\/p>"},{"src":"https:\/\/ps.w.org\/eacsoftwareregistry-distribution-sdk\/assets\/screenshot-3.png?rev=3092463","caption":"
UI Example 2 (Refresh\/Delete):\n<\/p>"}],"raw_content":"\n
{eac}SoftwareRegistry Distribution SDK<\/strong> is an extension plugin to {eac}SoftwareRegistry Software Registration Server<\/a>.<\/p>\n\n The Software Registry Distribution SDK is used to generate a custom PHP package that you can include in your software project to register your product with your registration server and manage that registration.<\/p>\n\n A custom version of this document is included in the generated SDK package.<\/em><\/p>\n\n The SDK provides most of the PHP code you will need to implement the Application Program Interface with your Software Registration Server.<\/p>\n\n Included with the Software Registration SDK package...<\/p>\n\n After extracting the In your project or class file, include Your class file must then:<\/p>\n\n Example:<\/p>\n\n (your_productid)_registration.interface.php will have your product and registration server API constants.<\/p>\n\n API Parameters<\/strong><\/p>\n\n API parameters are passed as an array:<\/p>\n\n * Required values (registry_key not required when creating a new registration).<\/em><\/p>\n\n If setting registry_transid, the recommended (not required) format is Any additional fields passed wil be saved as custom fields.<\/p>\n\n Although typically set by the Software Registry server, with the proper option setting, the API may<\/em> override:<\/p>\n\n Payment information may be posted with:<\/p>\n\n API Requests<\/strong><\/p>\n\n Create\/request a new registration...<\/p>\n\n Activate an existing registration...<\/p>\n\n Activate and Update an existing registration...<\/p>\n\n Deactivate an existing registration...<\/p>\n\n Verify or Refresh an existing registration...<\/p>\n\n Revise an existing registration...<\/p>\n\n API Response<\/strong><\/p>\n\n The API response is a standard object. status->code is an http status, 200 indicating success.<\/p>\n\n On a successful response (status->code = 200), the SDK will automatically cache the registration data and schedule the next refresh event (you do not have to do this).<\/p>\n\n notices<\/em> may be set (according to severity) to indicate an expiration or pending expiration and should be displayed to the user. Typically, only one notice will be set but they can be set via the message<\/em> is set via the supplemental<\/em> is set via the On an error response, an additional element is included:<\/p>\n\n error->message may be more informative than status->message.\nErrors may be handled with something like:<\/p>\n\n Useful methods built into the SDK...<\/p>\n\n Several hooks are available to customize or react to registration events.\nIn WordPresss, there are several actions and filters, for file based projects there are corresponding callback methods...<\/p>\n\n For WordPress Projects<\/strong><\/p>\n\n In your class constructor\/initialization, add an action to fulfill the registration refresh scheduled by the You can add this and other hooks with:<\/p>\n\n The Example:<\/p>\n\n Note:<\/p>\n\n If your primary plugin file name is not the same as the product id, edit your For Other File Based Projects<\/strong><\/p>\n\n The When left as is, the In your class constructor or destructor add:<\/p>\n\n to trigger the refresh check.<\/p>\n\n Example:<\/p>\n\n Of course, the user interface is up to you, the developer, but you may look at (and maybe use) the registration UI trait included with {eac}Doojigger<\/em> and used by {eac}SoftwareRegistry<\/em> as an example.<\/p>\n\n see:<\/p>\n\n {eac}SoftwareRegistry \u2013 Software Registration Server<\/a><\/p><\/li>\n {eac}SoftwareRegistry Custom Hooks<\/a><\/p><\/li>\n<\/ul>\n\n This program is free software: you can redistribute it and\/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.<\/p>\n\n This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.<\/p>\n\n You should receive a copy of the GNU General Public License along with this program. If not, see https:\/\/www.gnu.org\/licenses\/<\/a>.<\/p>\n\n\n {eac}SoftwareRegistry Distribution SDK<\/strong> is an extension plugin to and requires installation and registration of {eac}SoftwareRegistry<\/a>.*<\/p>\n\n This plugin is available from the WordPress Plugin Repository<\/a> and can be installed from the WordPress Dashboard \u00bb Plugins<\/em> \u00bb Add New<\/em> page. Search for 'EarthAsylum', click the plugin's [Install] button and, once installed, click [Activate].<\/p>\n\n See Managing Plugins -> Automatic Plugin Installation<\/a><\/p>\n\n Installation of this plugin can be managed from the WordPress Dashboard \u00bb Plugins<\/em> \u00bb Add New<\/em> page. Click the [Upload Plugin] button, then select the eacsoftwareregistry-distribution-sdk.zip file from your computer.<\/p>\n\n\n
(your_productid)_registration.(wordpress_or_filebased).trait.php<\/code><\/li>\n(your_productid)_registration.includes.php<\/code><\/li>\n(your_productid)_registration.interface.php<\/code><\/li>\n(your_productid)_registration.interface.trait.php<\/code><\/li>\n(your_productid)_registration.refresh.php<\/code><\/li>\n(your_productid)_registration.readme.md<\/code><\/li>\n<\/ul>\n\nSoftware Registry Implementation<\/h4>\n\n
(your_productid)_registration.zip<\/code> file, move the (your_productid)_registration<\/code> folder to your project.<\/p>\n\n(your_productid)_registration\/(your_productid)_registration.includes.php<\/code> to load the required interface and traits.<\/p>\n\n\n
\\(your_namespace)\\Interfaces\\(your_productid)_registration<\/code><\/li>\n\\(your_namespace)\\Traits\\(your_productid)_registration_(wordpress_or_filebased)<\/code><\/li>\n<\/ul>\n\ninclude \"(your_productid)_registration\/(your_productid)_registration.includes.php\";\n\nclass <your_classname> implements \\(your_namespace)\\Interfaces\\(your_productid)_registration\n{\n use \\(your_namespace)\\Traits\\(your_productid)_registration_(wordpress_or_filebased);\n ...\n}\n<\/code><\/pre>\n\nconst SOFTWARE_REGISTRY_PRODUCTID = '{your_software_registry_productid}';\nconst SOFTWARE_REGISTRY_HOST_URL = '{your_software_registry_host_url}';\nconst SOFTWARE_REGISTRY_CREATE_KEY = '{your_software_registry_create_key}';\nconst SOFTWARE_REGISTRY_UPDATE_KEY = '{your_software_registry_update_key}';\nconst SOFTWARE_REGISTRY_READ_KEY = '{your_software_registry_read_key}';\n<\/code><\/pre>\n\nUsing The API<\/h4>\n\n
$apiParams =\n[\n 'registry_key' => 'unique ID', \/\/ * registration key (assigned by registry server)\n 'registry_name' => 'Firstname Lastname', \/\/ registrant's full name\n 'registry_email' => 'email@domain.com', \/\/ * registrant's email address\n 'registry_company' => 'Comapny\/Organization Name', \/\/ registrant's company name\n 'registry_address' => 'Street\\n City St Zip', \/\/ registrant's full address (textarea)\n 'registry_phone' => 'nnnnnnnnnn', \/\/ registrant's phone\n 'registry_product' => 'productId', \/\/ * your product name\/id ((your_productid))\n 'registry_title' => 'Product Title', \/\/ your product title\n 'registry_description' => 'Product Description', \/\/ your product description\n 'registry_version' => 'M.m.p', \/\/ your product version\n 'registry_license' => 'Lx', \/\/ 'L1'(Lite), 'L2'(Basic), 'L3'(Standard), 'L4'(Professional), 'L5'(Enterprise), 'LD'(Developer), 'LU'(Unlimited)\n 'registry_count' => int, \/\/ Number of licenses (users\/seats\/devices)\n 'registry_variations' => array('name'=>'value',...), \/\/ array of name\/value pairs\n 'registry_options' => array('value',...), \/\/ array of registry options\n 'registry_domains' => array('domain',...), \/\/ array of valid\/registered domains\n 'registry_sites' => array('url',...), \/\/ array of valid\/registered sites\/uris\n 'registry_transid' => '', \/\/ external transaction id\n 'registry_timezone' => '', \/\/ standard timezone string (client timezone)\n 'registry_locale' => '', \/\/ standard locale\/language code\n];\n<\/code><\/pre>\n\n\n
{id}|{source}|{suffix}<\/code> where {id} is the transaction id, {source} indicates the source of the transaction, and {suffix} may be used as needed.<\/p>\n<\/blockquote>\n\n[\n 'registry_status' => 'status', \/\/ 'pending', 'trial', 'active', 'inactive', 'expired', 'terminated'\n 'registry_effective' => 'DD-MMM-YYYY', \/\/ Effective date\n 'registry_expires' => 'DD-MMM-YYYY', \/\/ Expiration date or term ('30 days', '1 year',... added to effective date)\n];\n<\/code><\/pre>\n\n[\n 'registry_paydue' => float, \/\/ amount to be paid\/billed,\n 'registry_payamount' => float, \/\/ amount paid,\n 'registry_paydate' => 'DD-MMM-YYYY', \/\/ date paid\n 'registry_payid' => 'payment id' \/\/ transaction id\/check #, etc.\n 'registry_nextpay' => 'DD-MMM-YYYY', \/\/ next payment\/renewal date\n];\n<\/code><\/pre>\n\n$response = $this->registryApiRequest('create',$apiParams);\n<\/code><\/pre>\n\n$response = $this->registryApiRequest('activate',['registry_key' => '<registrationKeyValue>']);\n<\/code><\/pre>\n\n$response = $this->registryApiRequest('activate',$apiParams);\n<\/code><\/pre>\n\n$response = $this->registryApiRequest('deactivate',['registry_key' => '<registrationKeyValue>']);\n<\/code><\/pre>\n\n$response = $this->registryApiRequest('verify',['registry_key' => '<registrationKeyValue>']);\n$response = $this->registryApiRequest('refresh',$apiParams);\n<\/code><\/pre>\n\n$response = $this->registryApiRequest('revise',$apiParams);\n<\/code><\/pre>\n\nstatus ->\n(\n code -> 200, \/\/ HTTP status code\n message -> '(action) ok' \/\/ (action) = 'create', 'activate', 'deactivate', 'verify', 'revise'\n),\nregistration ->\n(\n registry_key -> string \/\/ UUID,\n registry_status -> string, \/\/ 'pending', 'trial', 'active', 'inactive', 'expired', 'terminated', 'invalid'\n registry_effective -> string, \/\/ DD-MMM-YYYY effective date\n registry_expires -> string, \/\/ DD-MMM-YYYY expiration date\n registry_name -> string,\n registry_email -> string,\n registry_company -> string,\n registry_address -> string,\n registry_phone -> string,\n registry_product -> string,\n registry_title -> string,\n registry_description -> string,\n registry_version -> string,\n registry_license -> string,\n registry_count -> int,\n registry_variations -> array,\n registry_options -> array,\n registry_domains -> array,\n registry_sites -> array,\n registry_transid -> string,\n registry_timezone -> string,\n registry_locale -> string,\n registry_valid -> bool,\n),\nregistrar ->\n(\n contact -> object(\n name -> string \/\/ Registrar Name\n email -> string \/\/ Registrar Support Email\n phone -> string \/\/ Registrar Telephone\n web -> string \/\/ Registrar Web Address\n ),\n timezone -> string, \/\/ standard timezone string\n locale -> string, \/\/ WordPress locale\n cacheTime -> int, \/\/ in seconds, time to cache the registration response (Default Cache Time)\n refreshInterval -> int, \/\/ in seconds, time before refreshing the registration (Default Refresh Time)\n refreshSchedule -> string, \/\/ 'hourly', 'twicedaily', 'daily', 'twiceweekly', 'weekly', 'twicemonthly', 'monthly' - corresponding to refreshInterval\n options -> array( \/\/ from settings page, registrar_options (Allow API to...)\n 'allow_set_key',\n 'allow_set_status',\n 'allow_set_effective',\n 'allow_set_expiration',\n 'allow_activation_update'\n ),\n licenseCodes -> object( \/\/ may be changed by filter on registration server\n L1 -> 'Lite'\n L2 -> 'Basic'\n L3 -> 'Standard'\n L4 -> 'Professional'\n L5 -> 'Enterprise'\n LD -> 'Developer'\n LU -> 'Unlimited'\n ),\n notices -> object(\n info -> string, \/\/ information message text\n warning -> string, \/\/ warning message text\n error -> string, \/\/ error message text\n success -> string, \/\/ success message text\n ),\n message -> string, \/\/ html message\n),\nregistryHtml -> string, \/\/ html (table) of human-readable registration values\nsupplemental -> mixed, \/\/ supplemental data\/html assigned via filters (developer's discretion).\n<\/code><\/pre>\n\neacSoftwareRegistry_api_registration_notices<\/code> filter.<\/p>\n\neacSoftwareRegistry_api_registration_message<\/code> filter.<\/p>\n\neacSoftwareRegistry_api_registration_supplemental<\/code> filter.<\/p>\n\nerror ->\n(\n code -> 'error_code',\n message -> 'error message'\n),\n<\/code><\/pre>\n\nif ($this->is_api_error($response))\n{\n echo \"<div class='notice notice-error'><h4>Error \".$response->error->code.\" : \".$response->error->message.\"<\/h4><\/div>\";\n}\n<\/code><\/pre>\n\nMethods, Hooks, and Callbacks<\/h4>\n\n
$this->isValidRegistration();\n \/\/ Returns boolean\n if ( $this->isValidRegistration() ) {...}\n\n$this->getRegistrationKey();\n \/\/ Returns the current registration key\n $registrationKey = $this->getRegistrationKey();\n\n$this->getCurrentRegistration();\n \/\/ Returns the current registration object (above response object)\n $currentRegistration = $this->getCurrentRegistration();\n\n$this->isRegistryValue($keyName);\n \/\/ Returns the value of a specific registry key\n $regStatus = $this->isRegistryValue( 'status ');\n\n$this->isRegistryValue($keyName, $value, $test);\n \/\/ Returns boolean comparison of the value of a registry key ($test is '=|eq' (default), '<|lt', '>|gt', '<=|le', '>=|ge')\n if ( $this->isRegistryValue('license', 'L3', '>=') ) {...}\n<\/code><\/pre>\n\n filter\/callback: (your_productid)_api_remote_request( $request, $endpoint )\n @param array $request ['method'=>, 'timeout'=>, 'redirection'=>, 'sslverify'=>, 'headers'=>, 'body'=>]\n @param string $endpoint create, activate, deactivate, verify, refresh, revise\n @return array request body\n\n action\/callback: (your_productid)_api_remote_response( $body, $request, $endpoint )\n @param array $body response body\n @param array $request ['method'=>, 'timeout'=>, 'redirection'=>, 'sslverify'=>, 'headers'=>, 'body'=>]\n @param string $endpoint create, activate, deactivate, verify, refresh, revise\n\n action\/callback: (your_productid)_api_remote_$endpoint( $body, $request, $endpoint )\n @param array $body response body\n @param array $request ['method'=>, 'timeout'=>, 'redirection'=>, 'sslverify'=>, 'headers'=>, 'body'=>]\n @param string $endpoint create, activate, deactivate, verify, refresh, revise\n\n action\/callback: (your_productid)_api_remote_error( $error, $request, $endpoint )\n @param object $error {status:{}, error: {}}\n @param array $request ['method'=>, 'timeout'=>, 'redirection'=>, 'sslverify'=>, 'headers'=>, 'body'=>]\n @param string $endpoint create, activate, deactivate, verify, refresh, revise\n\n action\/callback: (your_productid)_update_registration($registration)\n @param array $registration registration object\n\n action\/callback: (your_productid)_purge_registration()\n<\/code><\/pre>\n\nWhat You Need To Do<\/h4>\n\n
scheduleRegistryRefresh()<\/code> method in (your_productid).wordpress.trait.php<\/code><\/p>\n\n\\add_action( '(your_productid)_registry_refresh', array($this, 'refreshRegistration') );\n<\/code><\/pre>\n\n$this->addSoftwareRegistryHooks();\n<\/code><\/pre>\n\naddSoftwareRegistryHooks()<\/code> method adds:<\/p>\n\n\\add_action( '(your_productid)_registry_refresh', array($this, 'refreshRegistration') );\n\\add_filter( '(your_productid)_is_registered', array($this, 'isValidRegistration') );\n\\add_filter( '(your_productid)_registration_key', array($this, 'getRegistrationKey') );\n\\add_filter( '(your_productid)_registration', array($this, 'getCurrentRegistration') );\n\\add_filter( '(your_productid)_registry_value', array($this, 'isRegistryValue'), 10, 4 );\n<\/code><\/pre>\n\ninclude \"(your_productid)_registration\/(your_productid)_registration.includes.php\";\n\nclass <your_classname> implements \\(your_namespace)\\Interfaces\\(your_productid)_registration\n{\n use \\(your_namespace)\\Traits\\(your_productid)_registration_wordpress;\n ...\n public function __construct()\n {\n $this->addSoftwareRegistryHooks();\n }\n}\n<\/code><\/pre>\n\n(your_productid).interface.tpl<\/code> file and change the SOFTWARE_REGISTRY_FILENAME<\/code> constant.<\/p>\n\n const SOFTWARE_REGISTRY_FILENAME = 'myPluginName';\n<\/code><\/pre>\n\nscheduleRegistryRefresh()<\/code> method in (your_productid)_registration.filebased.trait.php<\/code> is called to schedule the next registration refresh. This method can be modified to schedule a cron event to execute the refresh at a future time. The scheduled event may run (your_productid)_registration.refresh.php <registrationKeyValue><\/code> from the command line to refresh the registration.<\/p>\n\ncheckRegistryRefreshEvent()<\/code> method uses the key file to check for a needed registration refresh.<\/p>\n\n$this->checkRegistryRefreshEvent();\n<\/code><\/pre>\n\ninclude \"(your_productid)_registration\/(your_productid)_registration.includes.php\";\n\nclass <your_classname> implements \\(your_namespace)\\Interfaces\\(your_productid)_registration\n{\n use \\(your_namespace)\\Traits\\(your_productid)_registration_filebased;\n ...\n public function __destruct()\n {\n \/* if necessary, set HOME\/USERPROFILE and\/or TMP\/TMPDIR\/TEMP directories *\/\n \/\/ putenv('HOME={your home directory}'); \/\/ where the registration key is stored, otherwise use $_SERVER['DOCUMENT_ROOT']\n \/\/ putenv('TMP={your temp directory}'); \/\/ where the registration data is stored, otherwise use sys_get_temp_dir()\n $this->checkRegistryRefreshEvent();\n }\n}\n<\/code><\/pre>\n\nUser Interface<\/h4>\n\n
\n
See Also<\/h4>\n\n
\n
Copyright<\/h3>\n\n
Copyright \u00a9 2019-2025, EarthAsylum Consulting, distributed under the terms of the GNU GPL.<\/h4>\n\n
Automatic Plugin Installation<\/h4>\n\n
Upload via WordPress Dashboard<\/h4>\n\n