Kunskapsbas – Mjukvaruintegration via API

 

I den här artikeln kan du läsa om följande:

  1. Interaktiv API-dokumentation
  2. Hur du hanterar dina personliga åtkomsttoken
  3. Hur du hanterar webhooks för dina konton
  4. Hur du ger användare åtkomst till API-funktionerna

 

Mjukvaruintegration via API

PlanRadar tillhandahåller ett webb-API (Application Programming Interface) och webhooks. Det gör att du kan integrera tredje parts-mjukvara eller specialanpassad mjukvara i ditt PlanRadar-konto.

Att använda ett API kräver kunskap i mjukvaruutveckling. Ta hjälp av ett mjukvaruutvecklingsteam för att arbeta med API. Tyvärr kan inte vi på PlanRadar hjälpa våra kunder med anpassad mjukvaruutveckling.

 

Interaktiv API-dokumentation

Se till att du har behörighet för åtkomst till API-funktionerna innan du går vidare.
Du kan sedan gå till API-dokumentation via Inställningar > API-dokumentation:

 

Du kan direkt testa alla endpoints. För vissa endpoints behöver du specificera ett projekt-ID eller ett ärende-ID, vilket du oftast kan hitta och kopiera från din URL när du öppnar det specifika projektet eller ärendet.

Du kan också klippa och klistra ett curl-kommando och testa API:et via kommandofönstret. Du behöver dock ett åtkomsttoken. Hur det fungerar beskrivs i nästa stycke.

 

Hantera dina personliga åtkomsttoken

Använd personliga åtkomsttoken så att extern programvara kan autentisera mot våra servrar när ett API används.

Se till att du har behörighet för åtkomst till API-funktionerna innan du går vidare.
Du kan skapa och hantera personliga åtkomsttoken under Inställningar > Profil > Personliga åtkomsttoken.

 

Dessa token är användarbaserade. Du bör inte sprida information om dem till någon annan, och du bör hantera dem försiktigt. Om någon annan får tag på ett åtkomsttoken kan han eller hon få åtkomst till ditt konto och genomföra ändringar i ditt namn.

 

Maxgränsen är som standard 30 anrop/minut. Gränsen kan utökas på begäran. Kontakta [email protected].
 

Hantera webhooks för ditt konto

Webhooks gör att extern programvara kan reagera på events inom PlanRadar, som till exempel “ärende skapat”, “ärende uppdaterat”, “bild bifogad” och så vidare. Du kan skapa och hantera webhooks under Inställningar > Konto > Webhooks.

Det är bara kontoinnehavare som har åtkomst till denna inställning.

 

Klicka på “Lägg till ny webhook”. Här kan du välja vilka events du vill att din externa programvara ska få aviseringar om.

 

Autentisering:
Här kan du ange hur vi kan autentisera mot din server. I nuläget stödjer vi “HTTP Basic Authentication” med användarnamn och lösenord.

 

Headers:
Om du vill ha ytterligare headers för din tjänst kan du ställa in det här. Du kan välja att dölja lösenord och konfidentiellt innehåll i användargränssnittet. Det du väljer att dölja kan du inte ta upp i användargränssnittet igen efter det att du har sparat din webhook av säkerhetsskäl.

 

Ge användare behörighet för åtkomst till API-funktioner

För att få åtkomst till sidorna för API-dokumentation och personliga åtkomsttoken krävs rätt behörighet. Kontoinnehavare får automatiskt åtkomst till API-dokumentation.

För att ge andra interna användare rätt behörighet, gå till Hantera användare > Användare och redigera eller skapa en ny intern användare och kryssa för “API-åtkomst”

 

Ta bort andra användares åtkomsttoken

Du kan ta bort åtkomsttoken som andra interna användare har skapat. För att ta bort åtkomsttoken måste du ha behörighet att hantera användare.

För att ta bort ett åtkomsttoken som en användare har skapat, gå till Hantera användare > Användare, via navigeringsfältet. Välj den interna användare vars token du vill ta bort från systemet. Du ser användarens token till höger, och kan radera dem där.

 

Notera att åtkomsttoken som skapats av kontoinnehavaren inte kan tas bort av andra användare. Det är bara kontoinnehavaren som kan ta bort sina egna åtkomsttoken genom att gå till Inställningar > Profil > Personliga åtkomsttoken. 

Tillbaka till Innehållsförteckningen.