Bygg på Venue-API:et

Venue CMS är API-först. Allt som administrationsgränssnittet kan läsa är tillgängligt för din webbplats. Evenemang och kalendrar, artistprofiler, platser, sidor, medlemskap, produkter med mera. Vi erbjuder ett REST-API och två TypeScript-SDK:er. Du behöver inte vår mall för att använda vår backend, men den finns där som en utgångspunkt.

Kom igång

Installera @venuecms/sdk-next, lägg din site key och API-nyckel i miljövariablerna och hämta publicerat innehåll:

VENUE_SITE_KEY=your-site-key
VENUE_API_KEY=your-api-key

import { getEvents } from "@venuecms/sdk-next";

const { data } = await getEvents({ upcoming: true, dir: "asc" });

for (const event of data?.records ?? []) {
  console.log(event.slug, event.startDate, event.location?.city);
}

OpenAPI-specifikation

Den fullständiga API-specifikationen. Generera en typad klient från den i valfritt språk, eller använd vårt SDK, som är optimerat.

Visa OpenAPI-dokumentet

Publika endpoints

Den skrivskyddade ytan som en publik webbplats byggs av. Varje anrop autentiseras med en API-token, där din site key identifierar organisationen.

Referens: Dokumentation för REST-API:et
Autentisering: Authorization: Bearer <api-key>

Endpoint	Returnerar	SDK
`GET /site`	Site settings, locales and theme	`getSite()`
`GET /events`	Published events, paginated	`getEvents()`
`GET /events/dates`	Years and dates that have events, for calendar UI	`getEventDates()`
`GET /events/{slug}`	A single event	`getEvent()`
`GET /news`	News and blog posts	`getNews()`
`GET /news/dates`	Years and dates that have news posts, for archive UI	`getNewsDates()`
`GET /news/{slug}`	A single news post	`getNewsArticle()`
`GET /pages`	Published pages	`getPages()`
`GET /pages/{slug}`	A single page with its content tree	`getPage()`
`GET /profiles`	Artist and staff profiles	`getProfiles()`
`GET /profiles/{slug}`	A single profile	`getProfile()`
`GET /profiles/{slug}/events`	Events for one artist	`getProfileEvents()`
`GET /profiles/{slug}/products`	Merchandise and releases for one artist	`getProfileProducts()`
`GET /products`	Merchandise and releases	`getProducts()`
`GET /products/{slug}`	A single product	`getProduct()`
`GET /search`	Full-text search	`searchSite()`
`GET /tags`	Tag taxonomy	`getTags()`

SDK:er

Två publicerade paket som uppdateras regelbundet. Next.js-biblioteket är kraftigt optimerat — välj det om du inte bygger utanför Next.js.

@venuecms/sdk-next
A library optimised for Next.js. It bundles @venuecms/sdk, so there is nothing else to install, and adds React server components for rendering Venue content.
```
npm install @venuecms/sdk-next
```
https://docs.venuecms.com/developers/sdk-next
@venuecms/sdk
The TypeScript client for the Venue API, for builds outside Next.js. Runs in any fetch-capable runtime.
```
npm install @venuecms/sdk
```
https://docs.venuecms.com/developers/sdk

Startmall

template-minimal är en fungerande Next.js-webbplats för en konsertlokal eller artist — evenemang, artistprofiler, sidor och lokalisering är kopplade via SDK:et. Det är en snabb utgångspunkt som får dig igång med ett nytt projekt.

git clone https://github.com/venuecms/template-minimal.git

Visa på GitHub

Fullständig dokumentation

Guider, referens och båda SDK:erna i sin helhet. Varje dokumentationssida serverar även Markdown om du lägger till .md i URL:en, och hela specifikationen finns tillgänglig i en enda förfrågan, så att agenter kan bygga med den.

Läs dokumentationen

llms.txt — plattformen som ett maskinläsbart index