Een lokale externe clientapp maken met de API voor metagegevens

Nadat u een Salesforce DX project hebt gemaakt, configureert u het project om een lokale externe clientapp te maken.

1. Werk uw projectconfiguratiebestand met de naam sfdx-project.json bij door uw domein-URL toe te voegen aan de parameter sfdcLoginUrl.
   Als u de URL van uw Mijn domein wilt vinden, geeft u Mijn domein op in het vak Snel zoeken en klikt u vervolgens op Mijn domein.

   {
     "packageDirectories": [
       {
         "path": "force-app",
         "default": true
       }
     ],
     "name": "myEca",
     "namespace": "",
     "sfdcLoginUrl": "https://<URL from My Domain>",
     "sourceApiVersion": "61.0"
   }

2. Voeg deze parameters toe aan het definitiebestand van de scratch-organisatie met de naam project-scratch-def.json.
   • Voeg in het veld features ExternalClientApps en ExtlClntAppSecretExposeCtl toe.
   • Voeg in het veld settings de externalClientAppSettings toe en stel de enableExternalClientApps in op true.

     "features": ["EnableSetPasswordInApi", "ExternalClientApps", "ExtlClntAppSecretExposeCtl"],
     "settings": {
       "externalClientAppSettings": {
         "enableExternalClientApps": true
       },

3. Maak een package.xml-manifestbestand in de projectdirectory dat naar dit type verwijst.
   • ExternalClientApplication

   <?xml version="1.0" encoding="UTF-8"?>
   <Package xmlns="http://soap.sforce.com/2006/04/metadata">
       <types>
           <members>*</members>
           <name>ExternalClientApplication</name>
       </types>
       <version>61.0</version>
   </Package>
   

4. Maak in de map <projectdirectory>/force-app/main/default/ een directory met de naam externalClientApps.
5. Maak in de directory externalClientApps een bestand met de naam [ECAPP_NAME].eca-meta.xml. Bijvoorbeeld myeca.eca-meta.xml. Dit bestand is het headerbestand, dat wordt gebruikt om de externe clientapp te definiëren.
6. Configureer het headerbestand [ECAPP_NAME].eca-meta.xml. Zorg ervoor dat de distributiestatus is ingesteld op lokaal en configureer het bestand met deze informatie.

   Veld	Beschrijving
   contactEmail	Dit veld is verplicht. Type: Tekenreeks Het e-mailadres dat Salesforce gebruikt om contact met u of uw ondersteuningsteam op te nemen.
   beschrijving	Dit veld is optioneel. Type: Tekenreeks Een optionele beschrijving van uw app.
   distributionState	Dit veld is verplicht. Type: Tekenreeks De distributiestatus van een externe clientapp. Waarden kunnen Local of Packaged zijn. Een lokale externe clientapp werkt niet buiten de context van een organisatie. Het kiezen van de Packaged maakt de externe clientapp 2GP pakketbaar.
   iconUrl	Dit veld is optioneel. Type: Tekenreeks Gereserveerd voor toekomstig gebruik.
   infoUrl	Dit veld is optioneel. Type: Tekenreeks Een optionele URL voor een webpagina met meer informatie over uw app.
   label	Dit veld is verplicht. Type: Tekenreeks De naam van de app.
   logoUrl	Dit veld is optioneel. Type: Tekenreeks Het logo wordt weergegeven met de ingang van de app in de lijst van apps en op de instemmingspagina die de gebruiker ziet bij het verifiëren.
   isProtected	Dit veld is optioneel. Type: Booleaans. Het concept van een Beschermde component is afkomstig van pakketten en pakketontwikkelaars kunnen deze vlag gebruiken om de zichtbaarheid en bewerkbaarheid van hun componenten in abonneeorganisaties te bepalen.
   orgScopedExternalApp	Dit veld wordt gegenereerd tijdens de initiële implementatie. Nadat dit veld is gemaakt, is het verplicht. Type: Tekenreeks Unieke identifier van externe clientapp voor de app en de organisatie. Automatisch gegenereerd tijdens de eerste implementatie. Verwachte waarde: [Organization_ID]:[External Client App Name].

   In dit voorbeeld ziet u een headerbestand van de External Client App.

   
   <?xml version="1.0" encoding="UTF-8"?>
   <ExternalClientApplication xmlns="http://soap.sforce.com/2006/04/metadata">
       <contactEmail>johndoe@example.com</contactEmail>
       <description>Test external client app</description>
       <distributionState>Local</distributionState>
       <isProtected>false</isProtected>
       <label>myeca</label>
   </ExternalClientApplication>

• Een lokale externe clientapp implementeren
  Alle externe clientapps worden gemaakt met behulp van implementatie- en ophaalbewerkingen in de API voor metagegevens. Nadat u het bestand package.xml hebt geconfigureerd, implementeert u de externe clientapp.
• OAuth-invoegtoepassing inschakelen met API voor metagegevens
  In een externe clientapp verwijst het manifestbestand package.xml naar de instellingen- en beleidsbestanden voor elke invoegtoepassing. Configureer voor het inschakelen van externe clientapp-invoegtoepassingen de instellingenbestanden en verwijs naar de invoegtoepassing in het manifestbestand.
• De OAuth-invoegtoepassing voor de externe clientapp implementeren
  Nadat u het OAuth-instellingenbestand en het globale OAuth-instellingenbestand hebt geconfigureerd, implementeert u de wijzigingen om de externe clientapp bij te werken.
• Genereren van OAuth-beleid en -instellingen verifiëren
  Wanneer de OAuth-invoegtoepassing wordt geïmplementeerd, worden diverse componenten van de externe clientapp gegenereerd. Er zijn enkele plaatsen waar u kunt controleren of de implementatie is geslaagd.
• De OAuth-stroom voltooien
  Als u wilt controleren of de externe clientapp correct werkt, voert u een aanvraag Eindpunt autoriseren en een aanvraag Tokeneindpunt uit. Het tokeneindpuntverzoek produceert een API-toegangstoken dat kan worden gebruikt voor toegang tot elke Salesforce-API.