Best practice

For at opnå bedst mulig performance bør udviklere undgå udelukkende at arbejde på live-data. Dvs. når man eksempelvis henter en liste med opgaver, bør disse opbevares i en lokal data-store, fremfor at hente hele listen hver eneste gang. Selve implementeringen af denne data-store er helt op til dig.

Fordelene herved er åbenlyse:

• Din applikation reagerer langt hurtigere.
• Din applikation kan arbejde offline.
• Der spares båndbredde.
• Der åbnes op for muligheder som scheduleret synkronisering og lign.

Generelt skal det også tilstræbes at bruge den “mest rigtige” funktion. Hvis du eksempelvis skal hente en specifik opgave, er det oplagt at bruge selvsamme funktion hertil (hent specifik), i stedet for at hente alle opgaver og loope sig igennem listen indtil du finder den rigtige opgave. Lad din almindelige, sunde fornuft råde.

Tag højde for statuskoder

For hvert kald returneres der et svar med en statuskode. Læs denne for at se om kaldet gik godt, og hvis ikke, så brug den medsendte besked til at udbedre fejlen. Du kan se mulige statuskoder og deres forklaring i introduktionen.

Brug ‘modified’-feltet aktivt

Hvert data-element indeholder feltet ‘modified’ som angiver hvornår det sidst blev opdateret (uanset om det var via API eller brugergrænsefladen). Når du sammenholder feltets værdi med den værdi du har opbevaret lokalt, kan du hurtigt afgøre om der skal foretages en opdatering.

Send kun ændrede data

Når du opdaterer data, behøver du ikke sende alle felter med. Du kan nøjes med at sende de felter der skal opdateres, da API’et kun opdaterer de felter der modtages. Det vil eksempelvis sige at hvis du opdaterer en opgave og kun sender ‘priority’-feltet, er det kun opgavens prioritet der ændres. De andre felter forbliver uændrede. Hvis du derimod sender alle felter, hvor alle undtaget ‘priority’ er tomt, anses det som et ønske om at fjerne værdien fra de andre felter. Dette vil sædvanligvis medføre at der sendes en fejlkode retur. Så send enten hele den udfyldte struktur, eller kun det eller de felter du ønsker at opdatere.

Opbevar API-keyen lokalt

Hermed menes blot at hvis du bruger Hent konto til at hente din API-key på baggrund af dine normale login-informationer, bør du kun gøre det én gang per session. Dette kan være tilfældet hvis du udvikler en applikation hvor du ikke ønsker at brugeren skal besværes med at finde sin API-key og indsætte den, men i stedet blot kan indtaste sine login-informationer.
Bruger du API-keyen direkte (dvs. uden forudgående kald til Hent konto), gælder denne bemærkning således ikke dig.