Getting started

Start on Sandbox, create test and live API keys, add a test connection, then set your webhook URL. Live shops require a paid plan.

Base URL

The public REST API is served from the API host (not the marketing site):

Example request (replace the key with your ong_test_… or ong_live_… secret):

curl -sS "https://api.ongapi.com/v1/orders?limit=1" \
  -H "Authorization: Bearer ong_test_..."

The website and console live at https://ongapi.com. Marketplace OAuth callbacks and inbound platform webhooks stay on the Railway API hostname (https://ongapi.up.railway.app); your app calls and outbound webhooks use https://api.ongapi.com. See Platforms and OAuth.

1. Sign up at /sign-up with email or Google. You land on Sandbox. Create a test key on Console, then API Keys. The full secret is shown once.
2. Copy the test key (ong_test_…). Create a live key after you upgrade.
3. Console, then Connections: add a Sandbox connection. It uses the mock adapter. Ongapi does not store a marketplace seller password.
4. Console → Connections: on your Sandbox row, click Send test order (or POST to /internal/webhooks/mock with your mock shop_id). Then open Events for order.created.
5. Console → Webhooks: set an HTTPS endpoint to receive outbound delivery.
6. To connect a real shop, upgrade to Starter or above, then follow Platforms and OAuth.

Programmatic connect (ISV)

If you build an integration (for example a WMS or OMS), use a live API key and POST /v1/connections/authorize instead of the Console wizard. Send the seller to the returned authorize_url, then handle the redirect on your HTTPS return_url. Full parameters and success or error query strings are in Platforms and OAuth.

Ship, shipping labels, warehouses, and inventory writes are in Orders and events.

Integration guides on this site are the public API docs. For partner-application questions, email support@ongapi.com.