Skip to main content

Developers: Overview

The Developers settings section is where merchants configure integration credentials and app connectivity.

Tabs:

  • System Key
  • Credentials
  • OAuth Apps
  • Webhooks
  • Events
  • Logs

Which Credential To Use

CredentialToken PrefixUse It WhenNever Use It In
System API keyeshopos_test_ck_... / eshopos_live_ck_...Your own trusted backend services and internal automations need broad API accessBrowser, mobile app, client-side code
Secret keyeshopos_test_sk_... / eshopos_live_sk_...A developer's server needs write access to public API resourcesBrowser, mobile app, client-side code
Publishable keyeshopos_test_pk_... / eshopos_live_pk_...Frontend code needs safe read-only accessServer-side privileged write flows
OAuth access tokeneshopos_oat_...A third-party app installed by merchant via OAuth calls APIs for that merchantStoring permanently as a static key

What Developers Build On

Developers integrate against:

  • Public integration API: /api/public/v1/*
  • OAuth protocol endpoints: /api/public/v1/oauth/*

Private management routes are dashboard/backoffice-only and not part of this public integration surface.

Authentication Format

All credentials are sent as either:

  • Authorization: Bearer <token> (recommended)
  • X-API-Key: <token>

Bearer token is just the transport format. It is not a separate product.

Mode Rules (test vs live)

Modes are strictly separated:

  • Token prefix already encodes mode (test or live)
  • You can set request mode with X-EshopOS-Mode: test|live
  • If request mode and token mode differ, request is rejected with mode mismatch

Working Request Template

BASE_URL="http://localhost:8080"
TOKEN="eshopos_test_ck_replace_me"

curl -sS "$BASE_URL/api/public/v1/payments/supported-countries" \
-H "Authorization: Bearer $TOKEN" \
-H "X-EshopOS-Mode: test"

Next Reading