Skrivningar och återläsning
På den här sidan
Förhandsgranska ändringar, skriv medvetet och återställ ett osäkert resultat.
REST-operationer och nyckelbehörigheter
| Uppgift | Nyckelbehörigheter | Börja här |
|---|---|---|
| Förhandsgranska och spara fastigheter och lägenheter | write:properties; read:properties för återläsning | POST /api/v1/landlord/portfolio-imports/preview |
| Läs eller importera kommersiella hyreslistor | read:rent-roll; write:rent-roll för import | GET /api/v1/landlord/rent-roll |
Förhandsgranska, kontrollera, spara och läs tillbaka
Börja med den befintliga portföljimporten i två steg: skapa en oföränderlig förhandsgranskning, kontrollera dess giltighet och blockerande fel och spara sedan förhandsgranskningen med {"confirm":true}. Läs GET /api/v1/landlord/portfolio-imports/{importId} för att verifiera det beständiga resultatet. Även en förhandsgranskning lagrar data och kräver skrivbehörighet.
Behåll en identitet för varje skrivning
Varje ändring via hyresvärds-API:t kräver en Idempotency-Key på 16–200 tecken, med endast ASCII-bokstäver, siffror, punkter, understreck, kolon eller bindestreck och utan omgivande blanktecken. Skapa en nyckel per logisk operation och bevara den exakta anropskroppen och nyckeln. Använd separata nycklar för förhandsgranskning och sparande. Lyckade svar har ett återspelningsfönster på 24 timmar, avgränsat till samma API-nyckel och operation.
Återställ ett okänt skrivresultat
Efter ett förlorat svar: läs tillbaka resursen eller operationen om dess returnerade ID är känt. Om inget returnerat ID är känt, upprepa det identiska anropet med ursprunglig Idempotency-Key och ursprunglig API-nyckel inom 24 timmar från första försöket. Om fönstret har löpt ut eller säker återläsning/återspelning saknas, stanna och stäm av resultatet; varken en utgången nyckel eller en ny nyckel garanterar att skrivningen inte körs igen. Förhandsgranskningar, jobb och deras historik förblir bundna till nyckeln som skapade dem.
Bevara ansökningens åtkomsträtter
Versionerad ansökningsinlämning har ett annat kontrakt: bevara dess UUID X-Application-Submission-Key samt kvitto- och uppladdningsnycklar. Följ publicerade kvitto-/förloppsoperationer innan du försöker igen. Hyresvärds-API:ts Idempotency-Key ersätter inte dessa åtkomsträtter.
Använd den publicerade kontraktsversionen
Använd API-versionen och livscykeln i API-referensen, varje operations scheman samt eventuell nödvändig formulär- eller resursversion när en integration uppdateras. Bevara opaka versioner oförändrade och lås en godkänd MCP-release. Händelsenamn kommer från samma katalog som API:t; ankomstordning och en produktversion ersätter inte aktuell återläsning av resursen.