API

Formål

Som kunde hos Inspectly kan du få adgang til vores API. Dette kan bruges til at opbygge integrationer mellem dit eksisterende ERP-system og Inspectly.

Bemærk venligst, at Inspectly ikke tilbyder udvikling af den specifikke integration, men vi hjælper dog gerne vores kunder med at anvende API’et, så vi sammen kan skabe stærke integrationer mellem vores respektive systemer.

Brug af vores API

Du kan opbygge mange forskellige integrationer ved hjælp af vores API. Afhængigt af virksomhedens karakter og IT-politikker kan nogle af følgende være gode eksempler:

• Synkronisering af projekter og kunder

• Administration af skemakonfigurationer og tilknytning af disse til projekter

• Synkronisering af dokumenter og plantegninger

• Udtræk af registreringer

Pris

Adgang til API’et er gratis for alle kunder, der ikke har restance og som har et aktivt abonnement på vores services.

Teknisk dokumentation

På følgende URL kan du læse den tekniske dokumentation for vores API:
https://publicapi.inspectly.com/doc/index.html?url=/openapi/v1/openapi.json

Autentificering
For at autentificere dig mod API’et skal du tilføje 2 headers til din forespørgsel. Begge disse oplysninger får du ved at kontakte Inspectlys Customer Success-team på support@inspectly.com.

• X-ApiSecret

• X-ApiToken

Paging
Vi anvender pagination i API’et. Hvert endpoint har en sidestørrelse på 100 objekter og kan i øjeblikket ikke tilpasses.

Vi bruger OData-standarden, hvilket betyder, at objektet i GET-kald har en value-egenskab for dataobjektet og en nextLink-egenskab for den næste side. JSON-strukturen ser således ud:

Begrænsninger
For at sikre tilgængeligheden af API’et for alle vores kunder har vi opsat nedenstående begrænsninger. Alle begrænsninger gælder pr. grant token.

Grænsen er 100 API-kald pr. minut. Når grænsen nås, modtager du HTTP-fejlkode 429.

Filtrering og sortering
Når du laver GET-forespørgsler til API’et, har du mulighed for at filtrere og sortere resultaterne efter behov. De egenskaber, du kan anvende til disse funktioner, fremgår af dokumentationen for hvert endpoint.

Til filtrering og sortering bruger vi OData, hvilket betyder, at du kan tilføje parametrene $filter og $orderby til hver forespørgsel i querystringen. Se denne URL for OData-dokumentation:
https://www.odata.org

Fejlhåndtering
Hvis du sender fejlformaterede data til API’et, vil du modtage et valideringsfejlobjekt. Dette fejlobjekt er opbygget i overensstemmelse med standarderne fra FluentValidation.

HTTP-koder

• 200 – forespørgsel gennemført med succes

• 201 – objekt oprettet med succes

• 400 – valideringsfejl

• 401 – ikke autoriseret

• 429 – for mange forespørgsler. Se afsnittet “Begrænsninger”

• 500 – intern serverfejl. Oftest på grund af en fejl hos Inspectly. Kontakt venligst Inspectly ved at klikke her