Interacting with our data - API Docs

Interacting with our data - API Docs

Markket API Documentation

Note: We're currently in pre-release

While we strive for stability, some responses might change

We follow semantic versioning and avoid breaking changes to existing attributes

Overview

Markkët provides multiple ways to interact with your store data:

1. 🎯 REST API (Strapi+)

2. 🔄 Next.js API Routes

3. 📦 NPM Client Package (coming soon)

4. 🎨 Dashboard UI

Quick Start

Using the Strapi Client

import { strapiClient } from '@markket/api';

Fetch store data

const { data: store } = await strapiClient.getStore('your-store-slug');

Authentication

For protected routes, include a JWT token in your requests:

const headers = {

'Authorization': `Bearer ${token}`,

'Content-Type': 'application/json'

};

Data Guidelines

Stability Promise

- ✅ Existing attributes will maintain their types

- ✅ New attributes will be optional

- ✅ Deprecated fields will be marked before removal

- ❌ Breaking changes only in major versions

Best Practices

1. Include unit and integration tests

2. Use TypeScript and the optional chain operator

3. Implement error handling for API calls

4. Cache responses when appropriate

Working with Products

Use our API to synchronize your products with Stripe

Coming Soon

- 📦 NPM package with TypeScript support

- 🎨 Dashboard & components library

- 🔍 Enhanced search capabilities

- 📱 Mobile SDK

Support

For questions and support:

- 📧 Email: [email protected]

Built with ❤️ by the Markket team

Leaving this storefront?

Return to the Markkët homepage to browse other stores and sections.