help.sitevision.se hänvisar alltid till senaste versionen av Sitevision

Panelen REST-API

Här kan du aktivera Sitevisions REST-API för webbplatsen och ställa in begränsningar för "Cross origin" anrop.

REST API

REST-API

Aktivera REST-API för webbplatsen

Om du bockar i denna ruta aktiveras ett REST-API för webbplatsen . Dokumentation för REST-API:et når du på adressen <webbplatsadress>/rest-api/doc

Ha INTE denna ibockad om du inte använder vårt REST-API.

Åtkomst

Om du har aktiverat Sitevisions REST-API så bör du om du vill ha bra säkerhet även begränsa vilka som får ha åtkomst till det.

Begränsa åtkomst till REST-API

Bocka i denna ruta och klicka på länken Lägg till för att ge åtkomst till en användare/virtuell grupp eller alla inloggade användare

Säkerhet

Här ställer du in begränsningar för "Cross origin" anrop. Du kan ange följande:

  • Tillåt inte från någon domän
  • Tillåt från alla domäner
  • Tillåt endast för specifierade domäner. Du får då lägga till tillåtna domäner i en lista genom att klicka på länken Lägg till domän.

Denna användare/virtuella grupp bör ha rätt behörighet för att kunna utföra den operation som krävs i REST-API:et. Exempelvis ska användare skapas så krävs behörigheten "Hantera användare" osv.

Dokumentation och användning

Dokumentationen nås på <webbplatsadress>/rest-api/doc. Därifrån kan man utforska webbplatsen och även skicka REST-anrop. 

REST-API

Nodes

Här kan du navigera webbplatsens noder (sidnoder, mallar, filarkiv, bildarkiv, dekorationer, webbplatsfärger, formatmallar med mera).

Methods

Här finns alla tillgängliga metoder dokumenterade.

Errors

Här finns dokumentation över de felkoder som kan returneras.

Console

Här kan du exekvera REST-anrop. Observera att de exekverar skarpt.

Vill du inte skriva in URL för anropet kan du klicka på knappen "Copy URL" när den är tillgänglig (exempelvis när du under Nodes navigerat fram till en viss nod). Därefter klickar du på Console och klistrar in i URL-fältet överst. Du kan skicka med input data och du kan välja typ av anrop (Get, Put, Post och Delete).

Mer detaljerad information hittar du på sidan Model REST API på vår developer-webb.

Denna funktion kräver att du har behörigheten " Hantera funktioner för utvecklare"

Denna sida publicerades:

Hjälpte informationen dig?