Gå til innholdet

Delingslenker

Delingslenker lar deg gi en ekstern part (f.eks. en leverandør) tidsbegrenset, PIN-beskyttet tilgang til et prosjekt uten at de trenger en Wenn Property-konto.

Alle endepunkter krever scope manage:shares. Dette er separat fra read:projects — å lese et prosjekt gir ikke automatisk rett til å gi eksternt tilgang.

Authorization: Bearer <ditt-token>
FeltTypeBeskrivelse
shareIdstringUnik identifikator for lenken
createdAtstringISO 8601 opprettelsestidspunkt
createdBystringBruker eller klient som opprettet lenken
expiresAtstringISO 8601 utløpstidspunkt
isActivebooleanOm lenken er aktiv (ikke tilbakekalt)
accessCountintegerAntall vellykkede PIN-validerte tilganger
lastAccessedAtstring | nullISO 8601 siste tilgangstidspunkt
namestring | nullValgfri etikett, f.eks. leverandørnavn
pinstring4-sifret PIN. Server-generert. Returneres på opprettelse og listing
POST /v1/projects/{projectId}/shares

Oppretter en ny delingslenke. Serveren genererer en 4-sifret PIN og returnerer den i responsen. PIN-en kan også hentes senere via listeendepunktet.

Forespørselslegeme:

FeltTypeBeskrivelse
namestringValgfri etikett, f.eks. leverandørnavn
expiresAtstringValgfritt ISO 8601 utløpstidspunkt. Standard: 7 dager fra nå

Eksempel:

POST /v1/projects/abc-123/shares
Content-Type: application/json
{
"name": "Acme Tak AS",
"expiresAt": "2026-06-01T00:00:00Z"
}

Eksempel på respons (201 Created):

{
"shareId": "share-9f3a",
"createdAt": "2026-05-01T10:00:00Z",
"createdBy": "user@example.com",
"expiresAt": "2026-06-01T00:00:00Z",
"isActive": true,
"accessCount": 0,
"lastAccessedAt": null,
"name": "Acme Tak AS",
"pin": "4321"
}
GET /v1/projects/{projectId}/shares

Returnerer alle delingslenker for prosjektet — både aktive og tilbakekalte. Hver oppføring inkluderer PIN-en.

Eksempel på respons:

{
"shares": [
{
"shareId": "share-9f3a",
"createdAt": "2026-05-01T10:00:00Z",
"createdBy": "user@example.com",
"expiresAt": "2026-06-01T00:00:00Z",
"isActive": true,
"accessCount": 3,
"lastAccessedAt": "2026-05-04T08:23:00Z",
"name": "Acme Tak AS",
"pin": "4321"
}
]
}
PUT /v1/projects/{projectId}/shares/{shareId}

Oppdaterer utløpstidspunktet for en lenke. Det nye tidspunktet må være i fremtiden.

Forespørselslegeme:

FeltTypeBeskrivelse
expiresAtstringNytt ISO 8601 utløpstidspunkt (må være i fremtiden)

Eksempel:

PUT /v1/projects/abc-123/shares/share-9f3a
Content-Type: application/json
{
"expiresAt": "2026-07-01T00:00:00Z"
}

Returnerer den oppdaterte lenken (inkludert PIN).

DELETE /v1/projects/{projectId}/shares/{shareId}

Deaktiverer lenken. Tilgangshistorikken bevares (lenken slettes ikke fysisk), men mottakeren kan ikke lenger åpne den.

Returnerer 204 No Content ved suksess.

StatusKodeNår
400invalid_expiryexpiresAt er i fortiden
403Tokenet mangler manage:shares-scope
404project_not_foundProsjektet finnes ikke (ved opprettelse/listing)
404share_not_foundDelingslenken finnes ikke (ved forlengelse/tilbakekall)