Skip to main content
Een account installeert een app één keer, ongeacht hoeveel experiences het toevoegt, dus een installatie bevat status die bij het account hoort en niet bij één experience, zoals een sync-cursor of de ID van het account waaraan het in een ander systeem is gekoppeld. Gebruik de App Installations API om de accounts op te vragen waarop je app is geïnstalleerd, er één op te halen en de metadata en external_id die je app erop bijhoudt bij te werken. Een account kan ook de apps opvragen die erop zijn geïnstalleerd, en een developer elke installatie van zijn app. Alleen de app en de developer zien metadata en external_id, en alleen de app kan ze wijzigen.

Endpoints

Attributen

string
vereist
App-installatie-ID, met prefix aag_.
object
vereist
Account waarop de app is geïnstalleerd.

Eigenschappen

string
vereist
Account-ID, met prefix biz_.
string
vereist
Weergavenaam van het account.
object
vereist
App die is geïnstalleerd.

Eigenschappen

string
vereist
App-ID, met prefix app_.
object
vereist
Account dat de app ontwikkelt.

Eigenschappen

string
vereist
Account-ID, met prefix biz_.
string
vereist
Weergavenaam van het account.
object
vereist
App-icoon. Valt terug op het standaard app-icoon wanneer er geen is geüpload.

Eigenschappen

string
vereist
URL van de icoonafbeelding. Altijd aanwezig — het standaard app-icoon wanneer er geen is geüpload.
string
vereist
Weergavenaam van de app.
string
vereist
Wanneer de app voor het eerst op het account is geïnstalleerd, als ISO 8601-tijdstempel. Als de app later opnieuw wordt geïnstalleerd, blijft het oorspronkelijke tijdstip behouden.
string | null
vereist
De eigen identificatie van je app voor deze installatie, zoals de ID van het gekoppelde account in een ander systeem, of null wanneer er geen is ingesteld. Maximaal 255 tekens en uniek binnen de installaties van je app, zodat je een installatie kunt vinden met GET /app_installations?external_id=; een waarde instellen die een andere installatie al heeft, retourneert een 409. Alleen de app en de developer zien deze; voor het account waarop de app is geïnstalleerd is deze altijd null.
object | null
vereist
String-sleutels en -waarden die je app over deze installatie opslaat, zoals een sync-cursor of de ID van het gekoppelde account in een ander systeem. Leeg totdat je app een sleutel instelt, en behouden als het account de app verwijdert en opnieuw installeert. Maximaal 50 sleutels; sleutels zijn maximaal 100 tekens en waarden maximaal 500. Alleen de app kan dit wijzigen. Alleen de app en de developer zien dit; voor het account waarop de app is geïnstalleerd is dit altijd null.
boolean
vereist
Of de app nu om machtigingen vraagt die het account nog niet heeft goedgekeurd.
string
vereist
Wanneer de installatie voor het laatst is gewijzigd, zoals een metadata-update of een wijziging van de app-machtigingen door het account, als ISO 8601-tijdstempel.
AppInstallation