API & Integrations¶
Last reviewed: 2026-04-01 · Nnamdi
Status: Complete
Route: /settings/api-integrations
1. What is it?¶
API & Integrations is the developer-facing page for connecting external applications to Finora via its REST API. Businesses can generate API keys, manage their API credit balance, download integration plugins (WooCommerce), and access API documentation. The API allows creating invoices, receipts, managing customers and products, and real-time syncing with Finora.
2. How does it work in Finora?¶
2.1 KPI Summary¶
| Metric | Value (test business) |
|---|---|
| Credits Balance | NGN 0.00 (0 API calls available) |
| Cost per Call | NGN 100 per API request |
| Active API Keys | 0 keys in use |
Warning banner: "Low credits balance — Your credits balance is low. Top up now to avoid service interruption." — links to /api-credits
2.2 API Keys¶
- Generate New Key button
- Empty state: "No API keys yet — Generate an API key to connect your applications to Finora"
- Security Notice: "Keep your API keys secure — Never share your API key publicly or commit it to version control. If you suspect your key has been compromised, revoke it immediately and generate a new one."
2.3 Available Integrations¶
| Integration | Status | Actions |
|---|---|---|
| WooCommerce | Available | Download Plugin (/downloads/finora-woocommerce.zip) + View Guide |
| Shopify | Coming Soon | — |
| Custom Integration | Available | API Documentation link |
- WooCommerce: "Sync orders, invoices, and receipts from your WordPress/WooCommerce store"
- Shopify: "Automatically sync your Shopify orders and customer data"
- Custom Integration: "Build your own integration using our REST API"
2.4 API Pricing¶
| Details | |
|---|---|
| Trial | 10 free API calls |
| After trial | NGN 100 per API call |
| Credits | Uses same credits as verification services (top up at /api-credits) |
3. Business rules & constraints¶
| Rule | Detail |
|---|---|
| API keys must be kept secret | Never share publicly or commit to version control |
| NGN 100 per API call | After the 10 free trial calls |
| Shared credit pool | API calls and verification services (TIN/NIN) use the same credit balance |
| Revoke compromised keys immediately | User is responsible for all usage on their key |
| WooCommerce plugin available now | Shopify coming soon |
4. Nigerian regulatory context¶
API integrations are commonly used by Nigerian e-commerce businesses running WooCommerce or Shopify stores to sync orders and automatically generate Finora invoices and receipts for tax compliance.
5. Common customer questions¶
Q: "How do I connect my WooCommerce store?"
Download the WooCommerce plugin from the Available Integrations section, install it on your WordPress site, enter your Finora API key in the plugin settings, and follow the setup guide.
Q: "When will Shopify be available?"
Shopify integration is marked as "Coming Soon." No confirmed date.
Q: "What's the difference between API credits here and on the API Credits page?"
They're the same balance. The API Credits page (
/api-credits) is where you purchase credits; this page is where you manage API keys and integrations. Both draw from the same credit pool.
6. Known edge cases¶
NGN 100 vs NGN 200 per call¶
The API & Integrations page shows "NGN 100 per API request" while the API Credits page shows "₦200 per verification." These are different services: API calls (REST API requests) cost ₦100; verification services (TIN/NIN lookup) cost ₦200. Both use the same credit pool.
7. Escalation trigger¶
Escalate to Tier 3 (Founder) if: - API key generation fails - API calls return errors despite valid keys and credits
Escalate to Tier 2 (Support Lead) if: - Customer needs help setting up the WooCommerce plugin - Customer needs custom API documentation beyond what's published - Customer needs to revoke a compromised API key
8. Last reviewed¶
2026-04-01 — Nnamdi. Verified against production. API & Integrations for COA Test School Academy: Credits NGN 0 / Cost NGN 100 per call / 0 active keys. Low balance warning. Generate New Key button. WooCommerce (Download Plugin + View Guide), Shopify (Coming Soon), Custom Integration (API Documentation). API Pricing: 10 free trial calls, then NGN 100/call. Security notice confirmed.