За разработчици
Сайтът си остава ваш. Citron е бекендът, от който той чете.
Работите с каквато рамка искате. Четете публикуваното съдържание през REST или GraphQL, изпращате формуляри и заявки за срещи към публичните адреси и обновявате само страниците, които редакторът е променил.
SDK все още не е в npm. Дотогава го изпращаме като архив на пакета; пишете ни и ще го споделим с екипа ви.
Бърз старт#
Три стъпки от празен проект до страница, която се обновява сама, когато редактор публикува.
Създайте API ключ#
В конзолата отворете Настройки → Разработчици → API ключове и създайте ключ за публикуваното съдържание. Той започва с
ck_pub_и се показва само веднъж, затова го сложете веднага в средата на сървъра си..env.local # .env.local (server only) CITRON_BASE_URL=https://api.console.citronos.com CITRON_API_KEY=ck_pub_… CITRON_WEBHOOK_SECRET=whsec_…Прочетете съдържание#
Поискайте колекция по нейния slug.
localeдава преведените полета на един език. Справочникът за REST описва филтрите, сортирането, страниците и връзките.curl "https://api.console.citronos.com/v1/content/products?locale=en&pageSize=20" \ -H "Authorization: Bearer $CITRON_API_KEY"import { createClient } from '@citron/sdk'; const citron = createClient({ baseUrl: 'https://api.console.citronos.com', apiKey: process.env.CITRON_API_KEY, // ck_pub_… locale: 'en', }); const { data: products, meta } = await citron.collection('products').list({ limit: 20 }); console.log(meta.total, products.map((p) => p.slug));Обновявайте с уебкуки#
Добавете адрес, който проверява подписа и обновява променените страници, после го регистрирайте в Настройки → Разработчици → Уебкуки и копирайте тайния ключ в
CITRON_WEBHOOK_SECRET. Повече за уебкуките.app/api/citron-webhook/route.ts // app/api/citron-webhook/route.ts import { revalidateTag } from 'next/cache'; import { citronTags, createRevalidateHandler } from '@citron/sdk/next'; export const POST = createRevalidateHandler({ secret: process.env.CITRON_WEBHOOK_SECRET, onEvent: (e) => citronTags(e.collection, e.entry.slug).forEach((tag) => revalidateTag(tag)), });
Справочник#
REST API за доставка
Два адреса само за четене за всяка колекция: езици, филтри, сортиране, страници, връзки, ETag и подписани връзки за преглед на чернови.
GraphQL
Схема, изградена от вашите колекции, с филтри, връзки, чернови, persisted queries и ограничения на заявките.
AI конектори (очаквайте скоро)
Очаквайте скоро: свържете Claude, ChatGPT, Cursor и други AI инструменти с работно пространство през MCP, с OAuth или личен токен и със собствените права на члена на екипа.
Уебкуки
Събития при публикуване, сваляне и изтриване, подписи HMAC, повторни опити и обновяване на Next.js.
Формуляри, контакт и срещи
Публични адреси за контакт, формуляри и срещи с Turnstile, ключове за идемпотентност и защита от спам.
TypeScript SDK
Типизиран клиент без зависимости, генериране на типове от вашите колекции и помощници за Next.js.
Грешки и ограничения
Тялото на грешката, статусите и кодовете, идентификаторите на заявки и всички ограничения.
Ключове и среди#
ck_pub_…- Чете публикуваното съдържание. С ограничение на заявките за всеки ключ. Пазете го на сървъра или в edge среда.
ck_prev_…- Чете чернови за преглед. Пазете го на сървъра; никога не го изпращайте към браузъра.
Къде- „Настройки → Разработчици → API ключове“ и „Уебкуки“ в конзолата.
Базов адрес- https://api.console.citronos.com
Изпробвайте го с истинско работно пространство
Заявете достъп, после създайте колекция и публичен ключ и прочетете данните от сайта си.