How-To Guides
Step-by-step instructions for every major task — from first install to enterprise configuration.
1. How to Install and Activate the Plugin
- Download the Ingestics plugin ZIP file from AutoAPIWP.com or from your account dashboard.
- In your WordPress admin, go to Plugins → Add New → Upload Plugin.
- Click Choose File, select the downloaded ZIP, and click Install Now.
- Once installation completes, click Activate Plugin.
- You will see a new Ingestics menu item in the WordPress admin sidebar.
- Click Ingestics to open the plugin dashboard. The Setup Wizard will launch automatically on first run.
2. How Licensing Works in This Build
This build is Freemius-integrated and initializes Freemius by default.
- Go to Ingestics → License tab in the admin.
- Use Upgrade or My Account to manage plan and activation.
- Your tier is resolved from Freemius plan state. Paid features require the premium-capable build where applicable, and existing providers/posts/settings are preserved during the normal upgrade path.
- If needed, use the License tab status actions to refresh and confirm your current tier.
AAPI_Feature_Gate based on the currently resolved tier.3. How to Add Your First API Provider
- Go to Ingestics → Providers tab and click Add API Provider.
- Give the provider a name (e.g., “NewsAPI – Technology”) and enter the API endpoint URL.
- Select the HTTP method (GET is most common) and the expected response format (JSON, XML, etc.).
- Configure authentication: choose the auth type and enter your API key, Bearer token, or OAuth2 credentials. All credentials are encrypted on save.
- Add any required query parameters or request headers using the key/value fields.
- Use the JSON Path Selector to map response fields to WordPress post fields: title, content, excerpt, image URL, source URL, date.
- Set the post status (Publish / Draft / Pending) and optionally the post type (Lite+).
- Click Save Provider. The provider appears in the Providers list.
- Click Fetch Now to run a manual test fetch.
4. How to Add Your First RSS Provider
- Go to Ingestics → Providers and click Add RSS Provider.
- Enter a provider name and the RSS/Atom feed URL. If you only know the website URL, enable Auto-Discovery (Lite+) and Ingestics will find the feed automatically.
- Configure full-text extraction (Lite+) if the feed only provides truncated excerpts — set the max character limit and choose append or replace mode.
- If full-text extraction falls back to baseline mode for an item, that item is automatically forced to Draft for manual review.
- Configure the output mode (Business): full_content, excerpt, summary_only, title_only, or raw_payload.
- Set post status and post type as needed.
- Click Save Provider, then Fetch Now to verify the feed is accessible and items are imported correctly.
5. How to Use the Call Preview / Inspector Tool
- Select a provider and open its detail view.
- Click Load Planned Call to see exactly what request Ingestics will send: the full URL (with query params), all request headers, and the authentication method. Sensitive values are masked with
****. - Click Load Last Call to review the most recent actual request and response — useful for debugging unexpected results.
- Click Run Live Test (Lite+) to fire a real HTTP request immediately and display the raw response body and parsed items side by side.
6. How to Configure Scheduled Fetching (Lite+)
- Go to Ingestics → Schedule tab.
- Select your desired fetch interval: 1 hour, 2 hours, 4 hours, 6 hours, or 24 hours on Lite; 12 hours and Custom on Pro+.
- For a custom interval (Pro+), enter the value in hours (minimum 0.25 h, maximum 168 h). For example, enter 0.25 for every 15 minutes or 2 for every 2 hours.
- On Business, you can set separate intervals for the API pipeline and the RSS pipeline independently.
- Click Save Schedule. WordPress cron (
aapi_cron_fetchfor Lite/Pro, oraapi_api_cron_fetch+aapi_rss_cron_fetchfor Business) is registered immediately. - The next scheduled run time is displayed in the Schedule tab.
wp-cron.php on the configured interval.7. How to Set Up Provider Rotation (Lite+)
- Enable Rotation in the Schedule settings.
- When rotation is enabled, each cron run fetches from the next provider in sequence rather than all providers simultaneously. This distributes API calls evenly over time.
- On Business tier, API providers and RSS providers maintain separate rotation queues — you can rotate each independently.
- Use provider toggle to exclude a specific provider from the rotation without deleting it.
8. How to Use the Query Builder (Pro+)
- Open an API provider’s settings and click Open Query Builder.
- Select parameters to add: Country (ISO 3166-1 alpha-2), Category (contextual to the API type), Language (ISO 639-1), or Domain whitelist/blacklist.
- Each selection is translated to the correct query parameter for that provider type.
- Click Apply — the query parameters are written back to the provider URL or params fields automatically.
- Use Load Planned Call in the Inspector to verify the constructed URL before fetching.
9. How to Configure Pagination
- In your API provider settings, enable Pagination.
- For page-based pagination (Lite+): set the page parameter name (e.g.,
page), the starting page number, and the maximum number of pages to fetch per run. - For cursor / next-token pagination (Pro+): set the response field that contains the next cursor/token and the request parameter name to send it as on the following request. Ingestics handles the rest automatically across runs.
- Note: transient caching is automatically disabled for paginated providers to ensure fresh data on each run.
10. How to Set Up OAuth2 Authentication
- In your API provider’s auth settings, select OAuth2 – Client Credentials (Lite+) or OAuth2 – Auth Code (Pro+).
- Enter your Client ID and Client Secret (stored AES-encrypted).
- Enter the Token URL where Ingestics will exchange credentials for an access token.
- For Auth Code flow (Pro+): also enter the Authorization URL. The admin panel provides an OAuth callback handler — copy the displayed redirect URI into your OAuth app’s settings.
- Click Authorize (Auth Code) or Fetch Token (Client Credentials). Ingestics obtains the access token and stores it encrypted.
- Ingestics automatically refreshes the token before it expires on subsequent fetches.
11. How to Configure Content Filters (Pro+ / Business)
- Go to Ingestics → Filters tab.
- Each rule has an Enable toggle and an Action dropdown: Reject (discard item), Draft (save as draft), or Publish (allow through).
- Configure the available rules for your tier (see the table below).
- For Business threshold rules, set numeric limits: minimum title length (characters), minimum content length, long content threshold, broken image cache TTL.
- For Blocked Keywords (Business): enter comma-separated keywords. Any item with these words in the title or content triggers the configured action.
- Click Save Filters. Filters apply to every item on the next fetch.
| Rule | Pro | Business | Description |
|---|---|---|---|
| no_title | ✓ | ✓ | Item has no title or title is empty |
| no_content | ✓ | ✓ | Item has no content or description |
| no_source_url | ✓ | ✓ | Item has no source URL |
| invalid_url | ✓ | ✓ | Source URL is malformed or unreachable |
| duplicate_title | ✓ | ✓ | A post with this exact title already exists |
| duplicate_url | ✓ | ✓ | A post with this source URL already exists |
| short_title | — | ✓ | Title is below configured minimum character length |
| short_content | — | ✓ | Content is below configured minimum length |
| long_content | — | ✓ | Content exceeds configured maximum length |
| no_image | — | ✓ | Item has no featured image |
| broken_image | — | ✓ | Image URL returns an error or non-image content |
| blocked_keywords | — | ✓ | Title or content contains a blocked keyword |
| no_date | — | ✓ | Item has no publication date |
| no_description | — | ✓ | Item has no description or excerpt field |
12. How to Set Up Event Triggers & the Inbound Webhook (Pro+)
- Go to Ingestics → Settings → Advanced and copy the Webhook Trigger URL:
https://yoursite.com/wp-json/ingestics/v1/trigger. - Generate or enter a Webhook Secret. It is stored AES-encrypted. Share this secret with the external service that will call your endpoint.
- Configure the rate limit: maximum requests per IP per minute. Keep legacy GET method and query-string secret fallback disabled unless an integration absolutely requires them.
- In your external service (GitHub Actions, Zapier, Make, IFTTT, etc.), set up a POST request to the webhook URL with the header
X-AAPI-Webhook-Secret: your_secret. - Send a JSON body with the
fetch_typeparameter:api,rss,both, orpublish. Optionally includecampaign(Pro+) to trigger a specific campaign. - Ingestics validates the secret, checks the rate limit, and executes the requested operation.
- For WordPress-native automation, you can also trigger runs via
aapi_trigger_fetch,aapi_trigger_fetch_api,aapi_trigger_fetch_rss, andaapi_trigger_publish.
{
"fetch_type": "both",
"campaign": "my-campaign-name"
}13. How to Configure AI Rewrite (Business)
- Go to Ingestics → Settings → Pre-Publish Transform.
- Enable AI Rewrite and select the service: OpenAI, Anthropic Claude, Google Gemini, or Custom Endpoint.
- Enter the API key for the selected service (stored AES-encrypted). For Custom Endpoint, also enter the endpoint URL and auth value.
- Configure the rewrite scope: which fields to rewrite (title, excerpt, full content, or combination).
- Set character limits: max title chars (40–1000), max excerpt chars (80–8000), max content chars (1000–120,000).
- Enable Strict Mode if desired — when on, items that fail the rewrite guardrails are either skipped entirely or saved as
force_draftrather than published. - Click Save Transform Settings. AI rewrite now runs automatically as the first step of the pre-publish pipeline on every fetch.
14. How to Configure Translation (Business)
- Go to Ingestics → Settings → Pre-Publish Transform.
- Enable Translation and select the service: OpenAI, Anthropic, Gemini, DeepL, Google Translate, LibreTranslate, or Custom Endpoint.
- Enter the API key for the selected translation service (all stored AES-encrypted).
- Set the target language (ISO 639-1 code, e.g.,
frfor French,defor German). - Select which fields to translate: title, excerpt, content.
- Click Save Transform Settings. Translation now runs as the second step (after AI rewrite if enabled) of the pre-publish pipeline.
15. How to Display Posts with Shortcodes and Blocks (Lite+)
- Place the shortcode anywhere in a post, page, or text widget:
[auto_api_feed provider="my-provider-name" layout="grid" count="12" show_excerpt="true" show_image="true"]
- Available shortcode attributes:
provider— provider name or slug to displayfetch_type— api, rss, or bothpost_type— WordPress post type to querycount— number of items (default: 10)order— ASC or DESCorderby— date, title, rand, etc.layout— grid (Lite+), carousel (Pro+), ticker (Business)show_excerpt— true/falseshow_image— true/falseempty_message— text shown when no items foundclass— extra CSS classes for the wrapper
- For theme-level rendering, call
aapi_get_feed()oraapi_render_feed()directly in your template files. - In the Gutenberg block editor, search for Ingestics Feed and insert the block. Use the block settings panel to configure the same attributes visually.
- For Elementor (Pro+): find the Ingestics Feed widget in the Elementor widget panel and drag it onto the canvas.
- For Bricks Builder (Pro+): find the Ingestics Feed element in the Bricks elements panel.
16. How to Configure Stock Image Auto-Attach (Business)
- Go to Ingestics → Settings → General.
- Enable Stock Image Auto-Attach and select Pexels as the provider.
- Enter your Pexels API key (stored AES-encrypted).
- Configure the search query strategy: Ingestics uses the post title as the Pexels search query by default. You can override this with a static keyword or a field from the fetched item.
- Stock images are only fetched when a fetched item has no image AND no fallback image matches — they are the final fallback in the image priority chain: feed image → fallback (Pro+) → stock image (Business).
17. How to Set Up the External Webhook Bridge (Business)
- Go to Ingestics → Settings → Advanced and find the Connector Bridge section.
- Enter your Bridge URL (your Zapier webhook, Make webhook, or any custom endpoint URL).
- Enter a Bridge Secret — Ingestics uses it to generate an HMAC signature header (
X-AAPI-Signature) so your receiving endpoint can verify the source. Stored AES-encrypted. - Ingestics fires POST requests for both
fetch_run_completedandpost_publishedbridge events, including event metadata such as post ID/URL (for publish events), provider name, fetch type, campaign, and source URL where available. - In Zapier or Make, create a “Catch Hook” trigger pointed at the bridge URL, then build your automation from there (e.g., post to social media, send a Slack message, update a CRM record).
18. How to Configure Failure Digests (Pro+)
- Go to Ingestics → Settings → General and find Failure Digests.
- Enable Email Digest and enter the recipient email address. Digests include a summary of failed providers, error messages, item skip counts, and retry statuses.
- Enable Slack Digest and enter your Slack Incoming Webhook URL.
- Set the digest frequency. Digests fire on the cron schedule rather than immediately after each failure — this prevents notification floods during temporary outages.
19. How to Read the Activity Log
- Go to Ingestics → Activity Log tab.
- Each log entry shows: timestamp, event type (fetch / publish / error / license check), provider name, status (success / warning / error), and a detail message.
- Use the log to diagnose why items were skipped (duplicate, filter rejection, no image), why a fetch failed (auth error, timeout, 429), or to confirm the schedule is running.
- Click Clear Log to remove all entries (this is the only destructive action — it cannot be undone).
- On Business, click Export Log to download the full log as a CSV file.
20. How to Use Provider Health Monitoring (Lite+)
- Go to Ingestics → Dashboard or Providers tab. The Health Monitor panel shows a table of all providers.
- For each provider you can see: last fetch timestamp, last fetch status (success / warning / error), response latency (ms), total items fetched, total items published, and consecutive failure count.
- A provider flagged with a red status has failed its last fetch. Check the Activity Log for the specific error message.
- Use the health data to identify providers that are consistently slow (high latency) or unreliable (high failure count) and adjust their settings or disable them accordingly.