Skip to main content
Florals offentlige API er et JSON-baseret HTTP-API på:
Præfikset v1 identificerer den aktuelle offentlige kontrakt. Hver handling har også et stabilt operationId i OpenAPI-dokumentet til genererede klienter og integrationens logning.

​
Versionering og udfasning

Ændringer i v1 er bagudkompatible. Floral kan tilføje valgfrie svarfelter, handlinger og kompatible funktioner uden at ændre URL-versionen. Klienter bør ignorere svarfelter, de ikke bruger. En inkompatibel ændring i input eller svar kræver en ny API-version. Når en handling udfases, markeres den i den udgivne kontrakt sammen med en erstatning og en dato for lukning. En udfaset handling forbliver dokumenteret, til perioden slutter, og fjernes ikke uden varsel fra v1.

​
Et API-kalds forløb

Hvert kald til et offentligt endpoint skal:
  1. bruge HTTPS;
  2. sende et gyldigt bearer-token;
  3. bruge den workspaceSlug, nøglen er bundet til;
  4. opfylde de scopes, der står ved handlingen.
De påkrævede scopes står ved hver handling i API-referencen.

​
Tilgængelige handlinger

  • Virksomheder: hent lister og detaljer, opret, opdatér delvist, arkivér og gendan profiler.
  • Personer: hent lister og detaljer, opret, opdatér delvist, arkivér og gendan profiler og virksomhedsforbindelser.
  • Søgning: søg i virksomheder og personer, slå op i CVR-registeret, og hent offentlige definitioner af brugerdefinerede felter.
  • Briefings: hent lister og detaljer, og opret strukturerede virksomhedsbriefings.
  • Referater: hent lister og detaljer, erstat interne noter, og godkend referater, der kan godkendes.
API-referencen genereres fra registeret over offentlige handlinger. Hver handling beskriver metode, sti, input- og svarskema, scopes, headers, filtre, fejl og driftsprofil.

​
Paginering og filtre

Lister over virksomheder, personer, feltdefinitioner, briefings og referater bruger uigennemsigtig cursor-paginering. Sæt limit til 1-50. Standardværdien er 20. Når nextCursor ikke er null, sender du værdien uændret som næste kalds cursor. null betyder, at listen er udtømt. Filtrene afhænger af handlingen:
  • virksomheder: status, lifecycleStage og sort;
  • personer: status, lifecycleStage, sort og companyId;
  • feltdefinitioner: påkrævet entityType;
  • briefings: status, companyId, createdAfter og createdBefore;
  • referater: status, companyId, appointmentAfter, appointmentBefore og evidenceAudience.
Relationssøgning bruger q og en grænse på højst 20. Registeropslag bruger et præcist CVR-nummer eller et virksomhedsnavn. Datointervaller er inklusive og skal bruge ISO 8601, hvor starttidspunktet ikke ligger efter sluttidspunktet.

​
Svarheadere

Alle svar indeholder X-Request-ID og X-Content-Type-Options. Svar, der tæller mod en handlings grænse, indeholder også X-RateLimit-Limit og X-RateLimit-Remaining. Detaljekald og gennemførte skrivekald til ændringsbare ressourcer kan indeholde ETag. Oprettelse kan også indeholde en kanonisk Location. Læs Driftssikkerhed og nye forsøg, før du implementerer begrænsning af kald, idempotente nye forsøg eller optimistisk samtidighed.