Operationer¶

En integration består av flera operationer. Varje operation skickar ett anrop till ett API. För varje REST-Operation måste vi ange en URL, en Metod och vi kan även lägga till en Body.

Vi kan också definiera Variabler per Operation som kan användas i den Body vi skickar.

Allmänna inställningar¶

Namn är obligatoriskt och används i bland annat NOS-flödet för att visa tillgängliga Operationer. Det är inte ett krav men ge därför gärna operationen ett unikt namn.

Beskrivning visas bara i sammanfattning av integrationen och för själva operationen.

Operation

Prefix¶

För varje operation kan vi använda ett Prefix. Detta används i Parser-taggar och Workflow-variabler. Eftersom vi kan ha flera anrop i samma NOS-flöde krävs detta för att förhindra att variabler skrivs över.

Ge därför Prefixet ett unikt namn.

Variabler¶

Vi kan ange variabler som kan användas i operationen. Dessa skrivs in likt parser-taggar och använder prefixet var. Man kan ange typ och ett standard-värde.

Viktigt att tänka på är att när variabler används i Body behöver de formateras korrekt och omges av citationstecken.

Specifika inställningar¶

URL¶

Detta är adressen dit anropet går. Vi kan använda variabler i adressen. Dessa anges med prefixet var. och omsluts precis som parser-taggar. Ett exempel på en URL som använder en variabel är följande: https://localhost:44324/api/user/##var.USER_ID##

Metod¶

HTTP-protokollet som används vid REST-anrop stödjer ett antal metoder.

GET hämtar data.
POST används för att skicka data.
PUT används för att ersätta en resurs.
PATCH används för att skicka partiella uppdateringar av en resurs.
DELETE används för att radera data.
HEAD agerar som GET men utan ett komplett svar.
CONNECT används för att öppna en anslutning till servern.
OPTIONS används för att få reda på kommunikationsalternativ till en server.
TRACE används främst för diagnostik.

Headers¶

Varje anrop kan innehålla specifika Headers. Vanligtvis brukar headers skickas med om det krävs en särskild nyckel eller om man vill skicka och få tillbaka svar i olika format.

Body¶

Här skriver vi in ett objekt eller en lista med värden i JSON-format. Idag stödjer vi bara JSON-formatet.

Body skickas i stort sett aldrig vid GET-requests.

Vi kan använda variabler ovanför i anropet. Likt parsertaggar omges de av ##

Tips

En Body består oftast av JSON. Den behöver vara korrekt formaterad. Omge därför variabler med " om det är text-värden.

Exempel:

{
    "email": "##var.email##",
    "name": "##var.name##",
    "username": "##var.username##",
    "password": "##var.password##"
}