Skip to content
Arky Docs

Introduction to Arky

Welcome to Arky

Section titled “Welcome to Arky”

Arky is a developer-first platform for building modern web applications. Power your storefronts, booking systems, content sites, and newsletters with one unified TypeScript SDK.

What You Can Build

Section titled “What You Can Build”

With Arky, you can quickly integrate:

🛒 E-commerce Storefronts

Section titled “🛒 E-commerce Storefronts”

Fetch products, build carts, process payments, and manage orders

const { items: products } = await sdk.eshop.getProducts({ status: 'ACTIVE', limit: 20 });
const product = await sdk.eshop.getProduct({ id: 'prod_123' });
const quote = await sdk.eshop.getQuote({ items: cartItems, currency: 'usd' });
const result = await sdk.eshop.checkout({ items: cartItems, paymentMethod: 'CREDIT_CARD' });

→ See E-commerce Integration Guide

📅 Booking & Reservation Systems

Section titled “📅 Booking & Reservation Systems”

List services, show availability, accept bookings with payments

const { items: services } = await sdk.reservation.getServices({ limit: 50 });
const { items: providers } = await sdk.reservation.getProviders({ limit: 50 });
const slots = await sdk.reservation.getAvailableSlots({ serviceId: 'svc_123', providerId: 'prov_456', from, to });
const result = await sdk.reservation.checkout({ parts: [{ serviceId, providerId, startTime, endTime }] });

→ See Reservation Booking Guide

📝 Content-Driven Websites

Section titled “📝 Content-Driven Websites”

Pull CMS content for blogs, pages, and multilingual sites

const collection = await sdk.cms.getCollection({ id: 'blog' });
const { items: posts } = await sdk.cms.getCollectionEntries({ collectionId: 'blog', limit: 20 });
const title = sdk.utils.getBlockTextValue(post.blocks.find(b => b.key === 'title'), 'en');

→ See CMS Content Integration Guide

📧 Newsletter Subscriptions

Section titled “📧 Newsletter Subscriptions”

Manage free and paid newsletter subscriptions with Stripe payments

const { items: newsletters } = await sdk.cms.getCollections({ type: 'NEWSLETTER' });
await sdk.cms.subscribeToCollection({ collectionId, email, planId: 'plan_free' });

→ See Newsletter Integration Guide

Features Built-In

Section titled “Features Built-In”
  • 🔐 Authentication: Guest tokens, email/password, OAuth (Google), API keys
  • 💳 Payments: Stripe integration with multi-currency support
  • 🌍 Multi-Market: Different pricing and taxes per region
  • 📦 Media Management: S3-backed with automatic image optimization
  • 🔄 Real-time: WebSocket support for live updates

Developer-First Documentation

Section titled “Developer-First Documentation”

This documentation focuses on integration patterns - showing you exactly how to fetch data, build features, and integrate Arky into your applications.

Quick Navigation

Section titled “Quick Navigation”

Getting Started

Integration Guides (Learn by building)

API Reference (When you need details)

Supported Frameworks

Section titled “Supported Frameworks”

Arky is fully headless and works with any JavaScript/TypeScript framework:

  • Astro (SSR) - See arky.io for examples
  • React / Next.js
  • Vue / Nuxt
  • Svelte / SvelteKit
  • Vanilla JavaScript

How It Works

Section titled “How It Works”
┌─────────────────────────────────────────────────────────────┐
│                    Your Frontend                             │
│         (Astro, React, Vue, Svelte, Next.js...)             │
└────────────────────────┬────────────────────────────────────┘
                         │
                         │  TypeScript SDK (arky-sdk)
                         │  or REST API
                         │
┌────────────────────────▼────────────────────────────────────┐
│                      Arky Platform                           │
│                                                              │
│   CMS  │  E-commerce  │  Reservations  │  Newsletter       │
│                                                              │
│   Auth  │  Payments  │  Media  │  Analytics  │  Search     │
└──────────────────────────────────────────────────────────────┘

Your app connects to Arky via:

  • TypeScript SDK (arky-sdk) for frontend apps
  • REST API (api.arky.io) for any language/framework
  • Webhooks for real-time event notifications

Key Concepts

Section titled “Key Concepts”

Before diving into the API reference, familiarize yourself with these core concepts:

  • Business: Top-level tenant. Each business has its own data, users, roles, and configurations.
  • Markets & Zones: Multi-region pricing and tax/shipping rules.
  • Blocks: Typed fields for dynamic forms and structured content (think Notion-style blocks).
  • Collections & Entries: CMS content is organized into collections (like content types) and entries (like posts/pages).
  • Products & Variants: E-commerce catalog with multi-attribute variants and market-based pricing.
  • Services & Providers: Reservation system entities (e.g., “Haircut” service with multiple stylists as providers).
  • Quotes & Checkout: Unified payment flow across e-shop and reservations with promo codes, shipping, and tax calculation.

Next Steps

Section titled “Next Steps”