ForgeOpenPlatform
hu

OpenPlatform

Alkalmazás regisztrálása az OpenPlatformban

OpenPlatform · openplatform@5 openplatformappstokenssetup

Az alkalmazás egy rekord, amelyet az adminisztrátor a beállítási képernyőn hoz létre (/setup/, a setup bővítmény alkalmazás API-ja). A rekord a szerződés az OpenPlatform és az alkalmazásod között: hol él, hogyan igazolják egymásnak, kik ők, és mit tehet benne a felhasználó. A rekord sémája az @Apps a plugins/setup/schemas/apps.js fájlban.

MezőKötelezőJelentés
nameigena portálon megjelenő név
urligenaz a cím, amelyet az OpenPlatform megnyit
reqtokenigenegy titok, amelyet te választasz és mindkét fél ismer: ez írja alá a kérést
restokenigenegy második titok, szintén megosztott: az alkalmazás ezzel írja alá a válaszát
color, iconnemhogyan néz ki az alkalmazás a portálon
metanemegy cím (URL), amely visszaadja az alkalmazás metaadatait: a beállítási képernyő letöltheti (Apps/download), hogy kitöltse a rekordot
sortindexnema sorrend a listában (az új alkalmazás a végére kerül)
notificationsnemküldhet-e az alkalmazás értesítéseket
isexternalnemaz alkalmazás nem a portál keretében nyílik meg: az alkalmazásnak adott válasz iframe: false értéket tartalmaz
isbookmarknemaz alkalmazás egyszerű hivatkozás: nincs tokenegyeztetés, csak egy munkamenet-azonosító a lekérdezési karakterláncban
isnewtabnemúj böngészőlapon nyílik meg a portál kerete helyett (a newtab beállítás ezt minden alkalmazásra megteszi)
isscrollbarnemaz alkalmazás kerete a portálon megtartja a görgetősávját (a portál a scrolling értékét yes vagy no értékre állítja)
isdisablednemkikapcsolja mindenki számára: a felhasználó az "App has been temporary disabled" üzenetet kapja
permissionsnemaz alkalmazás jogosultságainak listája: mindegyiknek van id, name és value értéke (lásd csoportok és jogosultságok)

A tbl_app táblának van egy allow oszlopa is ("csak meghatározott IP-címeket enged"): ha címeket tartalmaz, az alkalmazás az OpenPlatform protokollvégpontjait csak onnan hívhatja. A fenti beállítási séma nem sorolja fel, tehát ez egy adatbázisoszlop, amelyet közvetlenül töltesz ki.

A két token

A reqtoken és a restoken soha nem kerül a böngészőbe. Az OpenPlatform ezekből minden indításhoz levezeti az utazó értékeket: az alkalmazás címében lévő tokent és az alkalmazás által visszaküldött fejlécet. A levezetés a hogyan csatlakozik egy app részben van. Használj hosszú véletlen értékeket és minden alkalmazáshoz más párt.

Eltávolítás és módosítás

Az alkalmazást soha nem törli a táblából: az eltávolítás (Apps/remove) beállítja az isremoved mezőt és az eltávolítás dátumát, törli a gyorsítótárat azoknál a felhasználóknál, akiknek megvolt, az isdisabled pedig eltávolítás nélkül kikapcsolja. Ha a platform címe (az url beállítás) megváltozik, az OpenPlatform törli minden felhasználó értesítési hivatkozásait és a nyitott alkalmazásmunkameneteket, mert mindkettő tartalmazza azt a címet (beállítások és adatbázis).

Emlékezz a README szabályára: egy regisztrált alkalmazás senki számára nem látható, amíg csoportot nem rendelsz hozzá.