Dokumentasjonsmeny
KI og integrasjoner
REST- og GraphQL-API-er
Les sider, menyer, medier og innstillinger fra apper, med API-nøkler og tilganger.
Slå på et av API-ene under Innstillinger › Integrasjoner. Begge er skrivebeskyttet og viser bare det besøkende får se: publiserte sider som ikke er passordbeskyttet eller bare for medlemmer, filer de sidene bruker, og offentlige innstillinger.
REST
På /api/aurora/v1. Legg til ?locale=nb for et annet språk.
| Endepunkt | Returnerer | Omfang |
|---|---|---|
GET /pages (?page=2, ?parent={id}) | Publiserte sider i kortform, 50 per side | pages.list |
GET /pages/{id} | En side med strukturerte blokker og SEO | pages.read |
GET /page?path=/about | Siden på en adresse (/ er forsiden) | pages.read |
GET /search?q=pricing | Søkeresultater med utdrag og poengsum | search |
GET /media, GET /media/{id} | Filer sidene bruker, med størrelser og srcset | media.read |
GET /menus/{location} | En meny og punktene i den | menus.read |
GET /settings | Nettstedets offentlige innstillinger | settings.read |
$ curl https://example.com/api/aurora/v1/page?path=/docs \
$ -H "Authorization: Bearer aurora_…"GraphQL
På /api/aurora/graphql (POST {"query": "…"}). Det tilbyr pages, page(id:, path:), search(query:), menu(location:), settings, media(id:) og mediaList, og verktøy som GraphiQL, Altair og Postman kan lese skjemaet. Spørringer som er nestet mer enn 10 nivåer dypt, avvises.
{
page(path: "/") {
title
seo { title description image { url width height } }
blocks
}
menu(location: "header") { items { title url children { title url } } }
}Strukturerte blokker
ID-er i blokkdata kommer ut som det de peker på: bilder og filer med URL-er, størrelser, srcset, alt-tekst og fokuspunkt; sidelenker med sidens tittel, sti og URL; skjemaer med feltene sine; formatert tekst som renset HTML.
API-nøkler
- Begge API-ene kan kreve en nøkkel, og de samme nøklene fungerer for begge. Apper sender den som
Authorization: Bearer <key>, aldri i adressen. - Hver nøkkel får navn etter det som bruker den, vises bare én gang, lagres hashet og kan trekkes tilbake: under Innstillinger › Sikkerhet › API-nøkler, eller med Administrer nøkler på fanen til hvert API.
- Hver nøkkel har tilganger: liste sider, lese sideinnhold, søke, lese filer, lese menyer og lese innstillinger. En forespørsel utenfor dem avvises.
