APIXX.flow logo
Back to app
Tutorial · ~15 min

Getting started

This walkthrough takes you from a brand-new tenant to your first canonical record in under fifteen minutes. We'll use a Shopify → APIXX Data example, but every step generalizes to any supported system.

Before you start

  • An invitation email from APIXX containing your sign-in link.
  • Admin access to at least one source system (we'll use Shopify Admin in this guide).
  • A modern browser. Flows is tested on Chrome 120+, Safari 17+, Firefox 121+, and Edge 120+.
Sandbox vs production
Every customer gets a sandbox tenant. We strongly recommend running this tutorial against sandbox first — it ships with sample data and rate-limited connectors so you can't accidentally write to a live system.

1. Sign in

  1. Click the link in your invitation email. It expires after 7 days — request a fresh one from your admin if needed.
  2. Set a password (12+ chars, 1 number, 1 symbol). If your tenant has SSO enabled, you'll be redirected to your IdP instead.
  3. Optional: enroll in MFA from Account. Required for admins.

You'll land on the dashboard at /. If you see a "No tenant" screen, your invite didn't finish provisioning — email support@apixx.io with your tenant name.

2. Tour the dashboard

The left sidebar groups everything by what you'll do most:

  • Overview — last-24h KPIs, recent runs, connector health.
  • Connectors — every credentialed link to an external system.
  • Flows — the integration pipelines themselves.
  • Runs — every individual execution of every flow.
  • Data — the canonical, normalized data layer.
  • Usage — plan limits and consumption.
  • Settings — API keys, branding, profile.

Look for the ? icon in the top-right of every page — it opens contextual help for that screen. The shield icon (admins only) toggles cross-tenant Admin Mode.

3. Add your first connector

  1. Go to Connectors and click Add connector.
  2. Pick Shopify from the catalog.
  3. Enter your store domain (your-shop.myshopify.com) and click Continue.
  4. You'll be redirected to Shopify to approve the OAuth scopes — APIXX requests read_orders, read_customers, read_products, and read_inventory by default.
  5. On return, Flow verifies the credentials and saves the profile. Status should read active.
Stuck on the OAuth handoff?
If Shopify returns "app not approved for this store," your store admin needs to approve the APIXX app in Shopify Admin → Apps and sales channels.

4. Build a flow

  1. Go to Flows and click New flow.
  2. Name it Shopify Orders → APIXX Data.
  3. Source: the Shopify connector you just added. Destination: APIXX Data (canonical).
  4. Entity: order. Schedule: every 15 minutes. Filter: leave blank for now.
  5. Mapping: the AI suggests a default map. Accept it for now — you can refine later in the Mapping Console.
  6. Click Save & activate.

5. Trigger a run

Don't wait for the 15-minute cadence — open the flow and click Run now. You'll be redirected to the run detail page with a live status badge.

  • InProgress → Successful typically takes 10–60 seconds depending on order volume.
  • If you see Partial, expand the errors panel — usually 1-2 records failed validation (e.g. unknown currency code).
  • If Error, the run aborted. Check the connector status first; if degraded, re-authorize.

6. Verify in APIXX Data

  1. Go to Data → Live Records and pick order.
  2. You should see your Shopify orders, deduplicated and normalized.
  3. Click any record to inspect its canonical fields, source row, and provenance trail.
  4. Open Coverage to see the new Shopify × order cell turn green.

What's next

  • Connectors — auth methods, scopes, and reconnect flows.
  • Flows — advanced schedules, filters, and dependency chains.
  • APIXX Data — schema, mappings, and the Mapping Console.
  • API Reference — pull canonical data into your own apps.
Next Connectors deep dive