Naar hoofdinhoud gaan

Een externe applicatie registreren

Doel​

Een extern systeem (een integratie, service of middleware) registreren, zodat het met zijn eigen referenties Parsware-API's kan aanroepen.

Vereisten​

  • Je bent als platformbeheerder aangemeld bij het Beheercentrum.
  • Je weet welke scopes het externe systeem nodig heeft (bijvoorbeeld leestoegang tot app-gegevens).

Stappen​

  1. Open de pagina App-registraties via de linkernavigatie.
  2. Voer een applicatienaam in die het externe systeem herkenbaar maakt.
  3. Selecteer in de lijst de scopes die de applicatie nodig heeft. Elke scope geeft een specifiek soort toegang.
  4. Kies de beveiligingsrollen die de applicatie heeft, als die er zijn. Dit leeg laten is de minste bevoegdheid: de applicatie mag het platform aanroepen en raakt geen enkel record aan. Een script van een aangepaste API draait als de applicatie, onder deze rollen — dus een applicatie waarvan de scripts records lezen of schrijven, heeft precies de ene rol nodig die dat mag, en die rol zou alleen machtigingen moeten krijgen in de omgevingen die de applicatie bedient.
  5. Selecteer App registreren.
  6. Een paneel toont de nieuwe Client-ID en het Clientgeheim. Kopieer het clientgeheim nu — het wordt maar één keer getoond en kan niet meer worden opgehaald.

Wat er achter de schermen gebeurt​

De externe applicatie wordt een geregistreerde API-client. Hij authenticeert zich met zijn client-ID en geheim om een kortlevend toegangstoken te verkrijgen, en roept daarmee de Parsware-API's aan. Het token is beperkt tot precies de scopes die je hebt toegekend, noemt je tenant en draagt de rollen die je hebt gekozen — en die bepalen welke records hij kan bereiken.

Problemen oplossen​

  • "Scope … can only be granted by the platform operator." — parsware.provision en parsware.portals.serve horen bij de eigen servers van de platformbeheerder (de website, de portalhost) en staan niet in uw lijst. Geen van uw toepassingen heeft ze nodig.
  • Een ingetrokken toepassing antwoordde nog even. Intrekken voorkomt meteen elk nieuw token, maar een token dat ze al heeft, controleert elke dienst zelf; het blijft werken tot het verloopt, binnen het uur. Wilt u haar meteen afsnijden, verwijder dan ook de rechten van haar rol in die omgeving: die worden bij elke aanroep gecontroleerd.
  • "Scope … is geen bekende platformscope." — een gevraagde scope staat niet in de catalogus. Selecteer alleen scopes uit de getoonde lijst.
  • "Rol … bestaat niet in deze tenant." — een gekozen rol is verwijderd voordat de registratie werd opgeslagen. Open het paneel opnieuw en kies nogmaals.
  • "Er moet minstens één scope worden toegekend." — selecteer minstens één scope voordat je registreert.
  • Je bent het clientgeheim kwijt — het geheim kan niet worden hersteld. Trek de registratie in en registreer de applicatie opnieuw om een nieuw geheim te krijgen.

Gerelateerde scenario's​

  • Een externe applicatie intrekken.