Client Area Get Started
SG365 CID DocumentationMade by Site Guard 365 • Stable tag 9.0
Contact Us
Complete Plugin Guide

SG365 CID Documentation

Detailed guidance for installing, configuring and operating the SG365 CID WooCommerce plugin. It connects PIDKey / CIDMS Confirmation ID requests with WooCommerce products, orders, allowances, logs, customer history and Business tokens.

Requires WordPress 6.5+Tested up to 6.8Requires PHP 8.0+Stable tag 9.0GPLv2 or later
Customer self-serviceOrder or token verification, Installation ID input, captcha and copy-ready CID result.
WooCommerce allowancesQualifying products and variations control the number of requests available per order.
Admin operationsDashboard, Admin Get CID, logs, settings, allowance tools, forms and user access.
Business tokensReusable tokens with request limits, expiry dates, refill and deleted-token recovery.
SG365 CID DashboardHealthy
Success1,284
Remaining326
Today18

Quick Start

5 steps

Follow these steps in order to connect the plugin with WooCommerce and publish the first customer CID form.

01Install and activateUpload the sg365-cid folder to /wp-content/plugins/, then activate SG365 CID from Plugins → Installed Plugins.
02Configure the APIOpen Settings → SG365 CID and enter the API key, primary endpoint, optional fallback endpoint, rate limit and captcha preferences.
03Enable a WooCommerce productEdit a product or variation and enable “Enable CID limit for this product”. Each qualifying quantity unlocks the configured allowance.
04Create the Get CID pageAdd [sg365_cid_form] to a normal WordPress page and save that page in the plugin settings where required.
05Add optional customer toolsUse [sg365_cid_history], [sg365_cid_limits] or [sg365_cid_check_limit] in customer-only support areas.
Before going live: place a test order, confirm allowance creation, submit a test Installation ID, verify the result is logged, and test the fallback behavior without exposing real customer information.

How the CID Workflow Operates

Order → CID

A normal customer request passes through verification, allowance checks, duplicate detection, API handling and logging.

1. Customer entitlement

The customer provides an order number or Business token. When email verification is enabled, the supplied email must match the expected entitlement.

2. Allowance check

The plugin checks the total allocation, previous usage, remaining requests and any configured expiry state.

3. Duplicate IID check

If the same verified order or email and Installation ID already produced a successful CID, the earlier result can be reused without reducing the remaining limit.

4. Primary and fallback API

The primary PIDKey / CIDMS endpoint is attempted first. A configured fallback can run before the request is recorded as failed.

5. Result and copy action

A successful Confirmation ID is shown immediately in the form with a copy-ready presentation.

6. Logged history

The request is connected with its customer, order or token, IID, result, status and operational metadata for later review.

Email behavior: the source documentation states that SG365 CID does not automatically email the generated CID. It displays the CID instantly and logs it. An optional email setting can insert allowance and Get CID page information into processing or completed WooCommerce messages.

WooCommerce Product Setup

Products & Variations

Only qualifying products should create CID allowances. Configure the exact product or variation that should unlock customer requests.

01Enable CID limits on a simple product
Edit the WooCommerce product and enable Enable CID limit for this product. Each purchased quantity can unlock one request according to the described default behavior. Save the product and test with a fresh order.
02Enable CID limits on a variation
Use the variation-level controls for variable products. Allowance recalculation is designed to recognize qualifying variations rather than treating every parent product identically.
03Order allowance counters
Per-order counters are stored with order metadata. The plugin can automatically re-synchronize missing allowance data whenever qualifying products are detected.
04Thank-you and View Order messaging
The plugin can promote the configured Get CID page on relevant customer screens. Later versions improved the button presentation and ensure the link opens in a new tab.
05Auto-expire unused allowances
When enabled, unused requests can expire after the configured number of days. Confirm the policy with customers before enabling this setting.

Settings Reference

Configuration Map

The available controls depend on the installed release and active Free, Premium or Business entitlement.

Setting areaPurposeImportant behavior
API keyConnects requests with the configured PIDKey / CIDMS service.Keep the key masked and available only to trusted administrators.
Primary endpointMain API destination for CID generation.Test connectivity before publishing the customer form.
Fallback endpointOptional backup destination after primary failure.A fallback attempt occurs before the request is finally marked failed.
API timeoutLimits how long the site waits for an endpoint response.Do not set so high that customer requests appear frozen.
Rate limitsControls repeated guest or logged-in requests.Version 8.0 separates guest and logged-in request controls.
Math captchaReduces automated abuse.Captcha visibility can be configured for guests or broader user groups.
Get CID pageStores the customer-facing page URL.Used by thank-you, order and optional email links.
Field visibilityControls email and order/token fields.Validation prevents the form from being left without a usable verification field.
Logs per pageControls pagination on CID history.Long histories use wider numbered pagination links.
Store failed attemptsDecides whether failed requests stay in logs.Disable only when the operational team does not need failure history.
Customer email linksAdds allowance and Get CID links to selected WooCommerce emails.This does not mean the generated CID itself is automatically emailed.
Auto-expiryExpires unused allowances after a configured period.Use a clear customer policy before activation.

Shortcode Reference

Front End

Place only the tools customers need. Keep history and allowance screens inside authenticated or customer-only areas where appropriate.

[sg365_cid_form]
Customer CID request formCollects the configured order or token identifier, email and Installation ID, then runs verification, quota and API logic.
[sg365_cid_history]
Logged-in customer historyShows up to the previous 50 CID requests for the current user. Version 8.0 improved masked history presentation.
[sg365_cid_limits]
Order allowance dashboardDisplays each qualifying order, total CID allowance and remaining requests in a responsive table.
[sg365_cid_check_limit]
Order or token limit checkerChecks remaining capacity after the configured email verification flow and uses responsive result tables.
<!-- Recommended customer support layout --> [sg365_cid_form] <h2>My remaining CID allowances</h2> [sg365_cid_limits] <h2>My recent CID requests</h2> [sg365_cid_history]

Complete Admin Page Guide

Every Module

The major plugin screens are grouped below with their practical purpose and operational boundaries.

01Dashboard
  • Reviews CID successes, errors, success rate and request trends.
  • Shows license status and top Business tokens or WooCommerce orders where entitled.
  • Provides quick instructions and shortcode references.
  • Use the dashboard for monitoring, not as a replacement for detailed log investigation.
02Admin Get CID
  • Premium administrator workflow for direct CID generation.
  • Can optionally look up a WooCommerce order and consume an available allowance.
  • Can confirm when an order does not have CID capacity.
  • Later versions include Installation ID and image-assisted interface choices where available.
  • Manual requests remain logged as administrator actions.
03CID Logs
  • Search by customer, order, token or Installation ID.
  • Review successful and failed states with clearer badges.
  • Use configured rows-per-page pagination.
  • Export through TXT or CSV controls where included.
  • Delete older records through the available retention tools.
  • Choose whether failed attempts should be stored.
04Settings
Configures API details, endpoints, timeout, rate limits, captcha behavior, field visibility, Get CID page, email options, logs and allowance expiry. Some settings are locked behind an active Premium or Business license.
05CID Allowance Adjuster
  • Business-only order allowance tool.
  • Revoke all remaining requests or subtract a custom number.
  • Version 6.5.1 records the latest five revoke actions with user and date attribution.
  • Use only after confirming the order and customer policy.
06User Manager
  • Administrator-controlled per-user access.
  • Assign hidden, read or write access by plugin page.
  • Administrators are not shown as ordinary managed users.
  • Use least-privilege access for support staff.
07Get CID Form Styles
  • Select Classic, Modern or available preset layouts.
  • Configure button colors, backgrounds, fonts, placeholders, alignment and icon or emoji choices.
  • Control visible verification fields and captcha presentation.
  • Version 8.0 separates styling from request-control settings more clearly.
08Tools and data actions
  • Provides maintenance and future operational utilities according to the installed release.
  • A gated wipe action can remove plugin logs, tokens and settings after license-key confirmation.
  • Back up the WordPress database before destructive actions.

Business Token Documentation

Business Plan

Business tokens give selected customers a reusable entitlement that does not depend on entering a normal order number for every request.

Create a token

Enter a token label, customer name, email, request limit and optional expiry. The success popup provides token details and copy-ready sharing text.

Manage usage

Review used and remaining requests, active or used state, customer information and request history.

Refill capacity

Version 8.0 adds clearer token refill controls. Confirm the intended new limit before applying it.

Recently Deleted

The recycle bin keeps the most recent five deleted tokens and trims older recovery entries when new deletions occur.

Restore a token

Use the Recently Deleted modal and restore action when the token was removed accidentally and is still eligible for recovery.

Customer verification

The customer selects token-based access, supplies the token and email when required, then submits the Installation ID.

Token sharing: send tokens only to the intended customer. Treat the token as an access credential because it can carry reusable request capacity.

License Guard and Entitlements

Premium Access

The license system validates the SG365 CID product, activated domain, plan, status and expiry before keeping paid capabilities available.

Verify and activate

AJAX verification and activation provide loading feedback and refresh the premium feature state after a successful response.

Masked key display

The active key is masked in the admin interface while plan, status, expiry and last-check information remain visible.

Supported paid states

The interface can identify Premium, Subscription and Business plan types according to the verification response.

Scheduled checks

The plugin rechecks license state automatically at least weekly according to the supplied description.

Invalid state reaction

Pending, suspended, deleted, expired or domain-reset states can disable Premium and Business capabilities.

Renewal flow

Renewed licenses are designed to reactivate entitled capabilities and refresh expiry messaging more smoothly.

Danger-zone actions: clearing logs, clearing tokens, resetting settings or wiping plugin data may be verification-aware and destructive. Take a database backup first.

Security, Privacy and Operational Safety

Controls

The documentation supplied for this plugin describes a controlled, logged request workflow. It does not claim that an external API can never fail.

Secure AJAX workflow

Customer and administrator actions should pass through the plugin's validation and authorization logic rather than direct unprotected requests.

Captcha and rate limiting

Use math captcha and realistic request limits to reduce automated abuse without blocking legitimate customers.

Duplicate IID reuse

A successful duplicate match avoids another API request and does not consume a second allowance.

Least-privilege staff access

User Manager can restrict individual pages to hidden, read or write access.

Responsive privacy choices

The allowance table removed the last-generated CID column in later releases, and customer history can display masked values.

License enforcement

Scheduled verification helps prevent expired or suspended paid capabilities from remaining active indefinitely.

Troubleshooting

Common Fixes
01The customer has no CID allowance
  • Confirm the purchased product or variation is CID-enabled.
  • Check that the relevant order contains the qualifying item and quantity.
  • Review order metadata and use automatic allowance re-sync where available.
  • Confirm the allowance has not expired or already been consumed.
02The primary endpoint returns an error
  • Confirm the API key and primary endpoint.
  • Review timeout configuration.
  • Confirm whether the fallback endpoint is configured and reachable.
  • Review CID Logs for the recorded status instead of repeatedly resubmitting.
03Captcha expired or the customer entered the wrong answer
Use the on-page reload control to receive a new math question without refreshing the full page. Check that caching or optimization tools are not freezing dynamic form state.
04A duplicate Installation ID appears
When the verified order or email and Installation ID match an earlier successful request, the plugin can reuse the previous CID. Confirm that the matching criteria are correct before treating the result as an error.
05Premium pages are visible but locked
  • Open the License page and verify the active key.
  • Check plan, domain, status and expiry.
  • Refresh the license state after renewal.
  • Remember that Business token and Allowance Adjuster access requires the appropriate entitlement.
06Tables do not fit on mobile
Use the responsive wrapper supplied by current versions. On very narrow screens, tables may scroll horizontally so every column remains available.
07The changelog popup does not open
This documentation page uses the native HTML dialog API with a fallback path. Make sure Elementor or a cache/minification tool has not removed the page script, changed element IDs or loaded the same HTML block twice.

Frequently Asked Questions

FAQ
01Does the plugin email the CID automatically?
No. According to the supplied plugin documentation, the CID is displayed instantly on the form and logged for reference.
02What happens when the primary API endpoint fails?
The configured fallback endpoint is attempted before the request is marked failed.
03Can a customer reuse a successful CID?
Yes. A matching successful order or email and Installation ID can return the earlier CID without consuming the allowance again.
04How many previous requests appear in customer history?
The supplied shortcode description states that the logged-in history view shows the previous 50 CID requests.
05Can customers use a token instead of an order number?
Business token workflows allow customers to enter a reusable token and view remaining token capacity.
06Can allowances expire?
Yes. Unused allowances can be automatically expired after the configured number of days.
Contact Support
No documentation sections matched your search.

SG365 CID Changelog

Select a release. The dialog has independent scrolling and can be closed using its button, the backdrop or Escape.

v8.0

Major Visual and Workflow Refresh

SG365 CID
  • Released a major visual refresh across the plugin and redesigned the admin experience for Dashboard, Admin Get CID, Token Management, CID Allowance Adjuster, Logs, User Manager, Settings, License, and Form Styles with a cleaner, more premium layout.
  • Improved front-end CID generation with smarter duplicate Installation ID handling so previously generated Confirmation IDs can be reused without consuming extra quota or sending unnecessary repeat API requests.
  • Enhanced the logged-in CID form with a cleaner single-field style, compact controls, quota summaries, inline errors, masked CID history values, copy-ready results, and better popup/table presentation for token or order-based allowances.
  • Refined shortcode visibility logic so guest users continue to use `[sg365_cid_form]` by default while logged-in users can use the dedicated logged-in form, with admin-side controls to change this behavior when needed.
  • Added refill controls for token limits, improved token/order allowance summaries, and updated popups so token codes or order IDs are shown more clearly instead of generic labels or email-based identifiers.
  • Reworked the Create Business Token flow with a redesigned admin page, improved centered success popup, cleaner token messaging, better copy output for email or WhatsApp sharing, and more polished modal behavior.
  • Expanded Token Management with a redesigned interface, Recently Deleted token recovery modal, restore actions, tighter table layouts, improved active/used status visibility, and cleaner action handling for business tokens.
  • Redesigned the CID Logs page with improved header layout, better table styling, clearer status badges, and updated pagination defaults while also fixing critical admin-side rendering and loading issues.
  • Added AJAX-based license verification and activation with loading animation, smoother status refresh, clearer license presentation, and better handling of premium feature activation after successful verification.
  • Improved the License page with a redesigned layout, premium feature overview, license type visibility for Premium, Subscription, and Business plans, and verification-aware actions for clearing logs, clearing tokens, and resetting settings.
  • Refreshed the Get CID Form Styles page with cleaner section layouts, stronger visual cards, improved background styling, and a separate request-control area for guest and logged-in rate-limit settings.
  • Improved CID allowance and quota handling throughout the plugin, including better active-limit counting, clearer remaining totals, order allowance adjustment tools, token refill support, and more user-friendly summaries on the front end.
  • Added a full HTML help/documentation page for the plugin covering shortcodes, admin pages, front-end workflow, FAQs, and troubleshooting guidance for store owners and staff.
  • Fixed multiple UI and workflow issues including broken or duplicated front-end fields, token table misalignment, missing logs page header, popup positioning issues, styling inconsistencies across admin pages, and other layout problems introduced during the major redesign cycle.
  • Updated plugin assets, styling structure, and interface consistency across newly redesigned pages to provide a more stable and polished SG365 CID experience overall.
v7.1.0

Admin Access and Responsive Tables

SG365 CID
  • Improved admin access defaults so shop managers are not blocked by hidden pages or permission notices.
  • Made the CID limit checker result table mobile-friendly and added a responsive wrapper for better scrolling.
  • Refreshed the license status table styling and highlighted the delete-data danger zone in red.
  • Updated the Get CID email button styling to use a bold blue call-to-action.
  • Verified compatibility with the latest WordPress, WooCommerce, and PHP versions.
v7.0.0

Styled Forms and Token Recovery

SG365 CID
  • Added background-aware admin Get CID, limit dashboard, and check-limit forms that inherit Form Styles colors while keeping responsive tables across devices.
  • Added a mobile-friendly `[sg365_cid_limits]` table with greener remaining badges and removed the last generated CID column for privacy.
  • Fixed the Get CID button icon toggle so saved icon/emoji choices and button colors apply beyond the default blue styling.
  • Added a recycle bin for the last five deleted tokens with restore controls, trimming older entries automatically on new deletions.
  • Added a gated wipe tool on the License page to drop all plugin data (logs, tokens, settings) after confirming the active license key.
  • Improved log pagination to honor the per-page setting with wider numbered links for long histories.
  • Ensured `[sg365_cid_check_limit]` result tables carry the chosen form background/button colors and display labels on mobile.
v6.5.1

Logs, Email Links and Allowance History

SG365 CID
  • Added an option to skip storing failed CID attempts so logs can focus on successful confirmations.
  • Ensured the Get CID page link on thank-you/order screens always opens in a new tab with a blue button style.
  • Introduced an email toggle that injects allowance + Get CID links into processing/completed messages when enabled.
  • Refreshed the Admin Get CID hero and dashboard snapshot/quick-instructions to be bolder and clearer.
  • Styled the limit checker shortcode/table for mobile with custom button colors and green remaining counters.
  • Added CID Allowance Adjuster history that keeps the last five revoke actions with user/date attribution.
  • Bumped assets to version 6.5.1 for cache busting and polish.
v6.5.0

Configurable Logs and Front-end Fields

SG365 CID
  • Added a configurable logs-per-page setting with wider pagination numbers to browse CID history faster.
  • Let admins rename the Get Confirmation ID button and choose which form fields (email and/or order/token) are displayed.
  • Enforced classic Get CID layouts while keeping field visibility validation so shortcode forms cannot be left empty.
v6.0.0

Renewal-Friendly License Flow

SG365 CID
  • Added a renewed-friendly license flow that reactivates Premium/Business perks instantly, highlights server messages, and refreshes expiry callouts.
  • Simplified the Get CID Form Styles screen (new backgrounds, cleaner controls, emoji opt-out) and refreshed the captcha reload icon for a minimal look.
  • Improved User Manager reliability (no search filter, working reset) and removed exports from the CID limit checker shortcode while keeping logs allocation accurate for CID-enabled products/variations.
v5.5.0

Exports and Limit Checker

SG365 CID
  • Added TXT/CSV export controls to the Logs page plus a “Check my CID limit” shortcode that surfaces limits in a colored table with optional exports.
  • Let admins toggle off button emojis, search/reset User Manager entries, and keep responsive log tables consistent across tabs and devices.
  • Refreshed versioning to 5.5.0 with continued security guards and WooCommerce dependency enforcement.
v5.0.0

WooCommerce Guard and Form Styling

SG365 CID
  • Added WooCommerce dependency enforcement plus quick License/Dashboard action links on the Plugins screen so activation paths are clear.
  • Added configurable form-style controls (alignments, button colors, 20+ emoji/custom icons, fonts, backgrounds, and custom placeholders) that properly unlock for Premium/Business and surface new form previews.
  • Improved admin and shortcode logs with token/user attribution links, tablet-friendly search bars above the tables, and matching responsive token management layouts.
v4.5.0

Proactive License Warnings

SG365 CID
  • Added proactive license handling: warnings at 30/10/5 days before expiry (and on suspension), highlighted red expiry labels, and automatic removal of expired keys with prompts to re-activate.
  • Hid administrators from the User Manager while keeping other SG365 CID tables mobile-friendly and notices visible to admins across plugin pages.
  • Unlocked the Form Styles page for active Premium/Business sites, added selectable presets with unique icons/fonts/colors, and prepared a forms image folder for FORM_1.PNG through FORM_5.PNG previews.
v4.0.0

User Manager and Form Preview

SG365 CID
  • Replaced the Roles Manager with an admin-only User Manager that assigns hide/read/write per user while still surfacing plugin menus.
  • Added a locked Form Styles preview with five designs, refreshed logs/token tables (admin + shortcode) for mobile screens, and kept the captcha reload emoji minimal.
  • Removed the free CID result note field and ensured free plans no longer display it on the form output.
v3.5.0

Business Tokens and Access Roles

SG365 CID
  • Added a Business Token creator popup with AJAX creation, reset confirmations, and color-coded mobile-friendly token/log tables.
  • Introduced a Roles Manager for Premium/Business sites to set per-page read or write access while keeping subscribers/customers hidden.
  • Enhanced captcha UX with more questions, emoji reload, centered Get Confirmation ID CTA, and configurable CID result notes.
  • Synced license expiry enforcement and raised minimum requirements to PHP 7.2 / WordPress 6.8.
v3.0.0

License Synchronization and Token Detail

SG365 CID
  • Synced license expirations from the verification API (including alternate expiry keys), color-coded the status chips, and added a handy “View changelog” button on the License page.
  • Streamlined the admin Get CID output so it only shows the CID with a copy button, tucked the math captcha reload into a compact 🔄 control next to the question, and added a free success note that displays beneath every front-end CID result.
  • Enhanced Business token workflows with detailed token details after creation, color-coded used/remaining cells, RESET-confirm resets, and log search summaries that report success vs. error counts for matching orders/tokens.
v2.5.0

Premium Admin Get CID

SG365 CID
  • Added a premium-only Get CID admin page that can optionally look up WooCommerce orders, confirm when no CID allowance exists, consume remaining limits when present, and log manual admin-only requests.
  • Locked the front-end Get CID form for Free sites while improving the dashboard with a shortcode reference table and redesigning the license page into a detailed table that highlights expired keys and clearly downgrades features to Free until renewal.
  • Math captcha can now be reloaded on-page when it expires, keeping users on the same form and avoiding page refreshes.
v2.0.0

Premium Settings and Allowance Adjuster

SG365 CID
  • Locked the SG365 CID settings screen behind an active Premium/Business license (with a built-in license modal + contact button), added a deactivate-license action, and expanded the snapshot so plan/status/expiry/months-remaining/last-checked data is visible everywhere while invalid responses now prompt you to buy a new key.
  • Kept the Create Token and Token Management menus visible for every site but display upgrade prompts when the Business plan is inactive, and introduced a Business-only CID Allowance Adjuster so you can revoke all pending requests or subtract a custom number of requests from any order in seconds.
  • Enhanced the dashboard with top Business tokens and top WooCommerce orders (last 30 days), refreshed the quick-start instructions, and hid the allowance/history shortcode messages for logged-out visitors while the Thank You / View Order screens now push your Get CID page button more prominently.
  • Added an auto-expire option for unused allowances, extra math questions, a guest/all-user captcha toggle, and automatic allowance re-sync/expiration checks so every qualifying order always receives the correct CID limit even if metadata was missing previously.
v1.3.1

Hardened License Guard

SG365 CID
  • Hardened the license workflow by sending the SG365 CID product ID with every verification, masking active keys on the settings screen, displaying plan/status/expiry guidance, and scheduling weekly (daily) syncs so suspended, expired or domain-reset licenses disable paid features immediately.
v1.3.0

Dashboard, Variations and Business Tokens

SG365 CID
  • Added an SG365 CID dashboard, refined settings (masked API key, Get CID page link, order detail summary toggle) and a license screen that validates Premium or Business keys.
  • Added variation-level CID toggles, automatic allowance recalculation, and improved thank you / order detail messaging.
  • Introduced Business token creation + management, including the ability for customers to enter a token instead of an order number on the front-end form and to see remaining token allowances.
  • Enhanced logs (20 entries per page, full IID view, bulk delete older than 1/3/6 months) plus five new math captcha prompts.
v1.2.0

CID Allowance Dashboard

SG365 CID
  • Added `[sg365_cid_limits]` shortcode so customers can review their CID allowance and last issued CID per order.
  • New logger helpers power accurate allowance totals (allocated vs. remaining).
  • Documentation refreshed with feature overview, shortcodes table and screenshots section.
v1.0.0

Initial Release

SG365 CID
  • Initial release with PIDKey / CIDMS integration, WooCommerce hooks, logging and customer history.
Select the fields to be shown. Others will be hidden. Drag and drop to rearrange the order.
  • Image
  • SKU
  • Rating
  • Price
  • Stock
  • Availability
  • Add to cart
  • Description
  • Content
  • Weight
  • Dimensions
  • Additional information
Click outside to hide the comparison bar
Compare