Integrationer

API-dokumentation

Kom igång med Securapilots tenant-API v1: token, bas-URL, behörigheter och gränser.

Résumé

Tenant-API:et v1 nås på er egen domän (https://<er-domän>.securapilot.com/api/v1) med en Bearer-token för ett tjänstekonto. Token skapas av en superadmin under Inställningar > API, har behörigheter (abilities), ett obligatoriskt utgångsdatum på högst 12 månader och kan begränsas till IP-adresser. Standardgränsen är 600 anrop per timme och token. API:et ger läsåtkomst till risker, tillgångar, kontroller, leverantörer, fynd, nyckelindikatorer och bevis, samt uppladdning av bevis.

Documentation complète de l'API

Tous les points de terminaison, champs, réponses et codes d'erreur figurent sur la page de documentation de l'API (en anglais).

Ouvrir la documentation de l'API (en anglais)

Securapilot API v1

Tenant-API:et låter system läsa organisationens register (risker, tillgångar, kontroller, leverantörer, revisionsfynd, nyckelindikatorer och bevis) och skicka in bevis med härkomst. Varje kund når API:et på sin egen domän.

Översikt

  • Bas-URL: https://.securapilot.com/api/v1, till exempel https://.securapilot.com/api/v1/risks
    - Autentisering: Bearer-token för ett tjänstekonto (Laravel Sanctum, inte JWT)
    - Format: JSON
    - Rate limiting: 600 anrop per timme och token som standard, kan ställas in per token

    ### Tillgängliga endpoints

    - GET /risks – Risker (read:risks)
    - GET /assets – Tillgångar (read:assets)
    - GET /controls – Kontroller (read:controls)
    - GET /vendors – Leverantörer (read:vendors)
    - GET /findings – Revisionsfynd (read:audit)
    - GET /kri – Nyckelindikatorer (read:kri)
    - GET /evidence – Bevis (read:evidence)
    - POST /evidence – Skicka in bevis med härkomst (write:evidence)

    ### Exempel

    curl -H "Authorization: Bearer " "https://.securapilot.com/api/v1/risks?per_page=50"

    ### Paginering och felformat

    Listor använder cursor-paginering. Styr sidstorleken med per_page (1 till 200, standard 50) och hämta nästa sida via meta.next_cursor. Med filter[updated_after] hämtar ni bara det som ändrats sedan senaste synkningen. Fel returneras som {"success": false, "error": {...}}.
  • help.stepByStep

    1

    Skapa token

    En superadmin skapar en token för ett tjänstekonto under Inställningar > API

    2

    Välj behörigheter och giltighet

    Ange abilities, ett utgångsdatum (högst 12 månader) och vid behov tillåtna IP-adresser

    3

    Spara token säkert

    Token visas bara en gång, spara den i en hemlighetshanterare

    4

    Anropa API:et

    Skicka token som Authorization: Bearer och testa med ett läsanrop, till exempel /risks

    5

    Läs den fullständiga dokumentationen

    Fält, svar och felkoder finns på sidan API-dokumentation

    help.tips

    help.goodToKnow
    • Förvara token säkert och använd den aldrig i klientkod
    • Ge varje integration en egen token med bara de behörigheter den behöver
    • Vid svar 429: vänta enligt Retry-After-headern innan nästa anrop
    • Återkalla token under Inställningar > API om den kan ha röjts

    Plus d'informations


    #

    Token och tjänstekonto

    En token tillhör ett tjänstekonto som aldrig kan logga in. Den skapas av en superadmin under Inställningar > API och visas bara en gång. Token är en personlig åtkomsttoken (Laravel Sanctum), inte en JWT. Den kan återkallas när som helst, och varje anrop loggas i revisionsloggen.

    Behörigheter (abilities)

    Varje token får de behörigheter ni väljer: `read:risks`, `read:assets`, `read:controls`, `read:vendors`, `read:audit`, `read:kri`, `read:evidence` och `write:evidence`. Saknas behörigheten svarar API:et med 403.

    ### Gränser

    Standardgränsen är 600 anrop per timme och token och kan ställas in per token. Vid 429 anger Retry-After-headern när ni kan försöka igen. Anrop med ogiltig token begränsas dessutom per IP-adress.

    ### Bevis

    Med `POST /evidence` kan externa system skicka in bevis för en kontroll. Beviset är härkomst och ändrar aldrig kontrollens implementations
  • eller effektivitetsstatus, som alltid är en persons bedömning.
  • Questions fréquentes

    Hur skapar jag en API-token?
    En superadmin går till Inställningar > API och skapar en token för ett tjänstekonto. Välj behörigheter, ange ett utgångsdatum (högst 12 månader) och vid behov tillåtna IP-adresser. Kopiera token direkt, den visas bara en gång.
    Är token en JWT och vilken adress används?
    Nej, token är en Bearer-token (Laravel Sanctum personal access token) för ett tjänstekonto. API:et nås på er egen domän: https://<er-domän>.securapilot.com/api/v1.
    Hur många anrop får jag göra?
    Standardgränsen är 600 anrop per timme och token och kan ställas in per token. Vid svar 429 anger Retry-After-headern när ni kan försöka igen. Misslyckade token-anrop begränsas dessutom per IP-adress.

    help.wasHelpful

    Nous utilisons des statistiques anonymes sans cookies pour améliorer le site. En savoir plus