001 / DOCS

API Providers

Configure REST API providers in Ingestics to fetch data from any API endpoint.

Adding an API provider

1. Go to Ingestics → API Providers → Add New
2. Enter a provider name (e.g., “Weather API”)
3. Select the post type for imported content
4. Enter the API endpoint URL
5. Select the HTTP method
6. Configure authentication
7. Set up pagination (if needed)
8. Map response fields to WordPress fields
9. Configure publishing rules
10. Save and test with Fetch Now

HTTP methods

Ingestics supports all standard HTTP methods:

• GET — Fetch data from the API (most common)
• POST — Send data to the API and fetch the response
• PUT — Update a resource and fetch the response
• PATCH — Partially update a resource
• DELETE — Delete a resource

Authentication methods

All credentials are encrypted with AES-256-CBC before storage. See Security and Encryption.

Response formats

Ingestics parses 6 response formats automatically:

• JSON — Most common. Supports nested objects and arrays via JSON-path notation.
• XML — Supports attributes and nested elements. Common in legacy APIs.
• RSS — RSS 2.0 format. Treated as an RSS feed.
• CSV — Comma-separated values. First row treated as headers.
• HTML — Parsed with DOM selectors. Useful for scraping structured pages.
• Text — Plain text response. Used as-is.

Pagination

For APIs that return paginated results, configure the pagination method:

• Offset pagination — Uses page and per_page parameters. Ingestics increments the page number until no more results are returned. (Free+)
• Cursor pagination — The API returns a cursor or next-page URL in the response. Ingestics follows the cursor until exhausted. (Lite+)

You can also set a maximum number of pages to fetch per run.

Headers

Add custom HTTP headers to your API requests. Common use cases:

• Accept: application/json — Request JSON response
• Content-Type: application/json — Send JSON body
• User-Agent: MySite/1.0 — Custom user agent
• X-Custom-Header: value — API-specific headers

Retry handling

Ingestics automatically retries failed requests:

• Basic retry — Retries once after a short delay (Free)
• Exponential backoff — Retries with increasing delays (1s, 2s, 4s, 8s) up to 4 attempts (Lite+)

Provider limits by edition

Chained API requests (Business only)

On the Business edition, you can chain multiple API calls in sequence. The output of one request feeds into the next via variable substitution. For example:

1. Fetch a list of product IDs from /api/products
2. For each ID, fetch detailed product info from /api/products/{id}
3. For each product, fetch inventory from /api/inventory/{id}

This is useful for APIs that require multiple calls to gather complete data.