Welke API moet ik gebruiken?

Wanneer gebruikt men de REST API?

De REST API biedt een krachtige, handige en eenvoudige op REST gebaseerde webservice-interface voor de interactie met Salesforce. Tot de voordelen ervan behoren eenvoudige integratie en implementatie, terwijl het een uitstekende keuze van technologie is voor het gebruik bij mobiele toepassingen en webprojecten. Voor bepaalde projecten wilt u de REST API mogelijk gebruiken met andere Salesforce REST API's. Als u een UI wilt ontwikkelen voor het maken, lezen, bijwerken en verwijderen van records, inclusief het maken van UI voor lijstweergaven, acties en afhankelijke keuzelijsten, gebruikt u de gebruikersinterface-API. Als u UI wilt bouwen voor B2B Commerce op Lightning, CMS beheerde content, Experience Cloud-sites of Chatter, gebruikt u Connect REST-API. Als u vele records te verwerken hebt, kunt u overwegen om de Bulk API te gebruiken, die is gebaseerd op REST-principes en is geoptimaliseerd voor grote sets gegevens.

Zie de REST API Developer Guide (Ontwikkelaarshandleiding voor de REST API).

Wanneer gebruikt men de SOAP API?

De SOAP API biedt een krachtige, handige en eenvoudige op SOAP gebaseerde webservice-interface voor de interactie met Salesforce. U kunt de SOAP-API gebruiken om records te maken, op te halen, bij te werken of te verwijderen. U kunt de SOAP API ook gebruiken voor zoekopdrachten en andere taken. Gebruik de SOAP API in elke taal die webservices ondersteunt.

Zo kunt u de SOAP API gebruiken voor de integratie van Salesforce met de ERP- en financiële systemen van uw organisatie. U kunt ook real-time verkoop- en ondersteuningsgegevens leveren aan bedrijfsportals en kritieke bedrijfssystemen voorzien van gegevens op het gebied van klanteninformatie.

Zie de SOAP API Developer Guide (Ontwikkelaarshandleiding voor de SOAP API).

Wanneer gebruikt u de Connect REST-API?

Connect REST-API biedt programmatische toegang tot B2B Commerce voor Lightning, CMS beheerde content, Experience Cloud-sites, bestanden, kennisgevingen, topics en meer. Gebruik de Connect REST-API om Chatter-feeds, gebruikers en groepen weer te geven, met name in mobiele toepassingen.

Zie de Connect REST API Developer Guide (Ontwikkelaarshandleidng voor de REST API).

Wanneer gebruikt u de Apex REST API?

Gebruik de Apex REST API wanneer u uw Apex-klassen en -methoden zodanig zichtbaar wilt maken dat externe toepassingen toegang tot uw code kunnen krijgen via de REST-architectuur. De Apex REST API ondersteunt OAuth 2.0 en Sessie-ID voor autorisatie.

Zie Apex Developer Guide: Apex klassen zichtbaar maken als REST Web Services.

Wanneer gebruikt u de Apex SOAP API?

Gebruik de Apex SOAP API als u Apex-methoden zichtbaar wilt maken als SOAP-webservice-API's zodat externe toepassingen toegang tot uw code hebben via SOAP.

De Apex SOAP API ondersteunt OAuth 2.0 en Sessie-ID voor autorisatie.

Zie Apex Developer Guide: Apex methoden zichtbaar maken als SOAP Web Services en SOAP API Developer Guide: Aan Apex gerelateerde aanroepen.

Wanneer gebruikt u de Analytics REST-API?

U hebt met behulp van de Analytics REST-API programmatisch toegang tot CRM Analytics-activa zoals gegevenssets, lenzen en dashboards. Query's en toegangsgegevenssets verzenden die zijn geïmporteerd in het Analytics-platform. Lenzen maken en ophalen. Toegang tot XMD-gegevens. Een lijst van gegevenssetversies ophalen. CRM Analytics-apps maken en ophalen. Dashboards maken, bijwerken en ophalen. Een lijst van afhankelijkheden voor een toepassing ophalen. Bepalen welke voorzieningen beschikbaar zijn voor de gebruiker. werken met momentopnamen. Gerepliceerde gegevenssets manipuleren.

Zie de Analytics REST API Developer Guide.

Wanneer gebruikt men de gebruikersinterface-API?

Maak Salesforce-UI voor native mobiele apps en aangepaste webapps met behulp van dezelfde API die Salesforce gebruikt om Lightning Experience en Salesforce voor Android, iOS en het mobiele web te maken. Maak gebruikersinterfaces waarmee gebruikers kunnen werken met records, lijstweergaven, acties, favorieten en meer. U krijgt niet alleen gegevens en metagegevens in één reactie, maar de reactie reflecteert ook wijzigingen in metagegevens die in de organisatie zijn aangebracht door Salesforce-beheerders. U hoeft zich geen zorgen te maken over lay-outs, keuzelijsten, beveiliging op veldniveau of delen. U hoeft slechts een app te bouwen waar gebruikers dol op zijn.

Zie de User Interface API Developer Guide (Ontwikkelaarshandleiding voor de gebruikersinterface-API).

Wanneer gebruikt men de GraphQL-API?

Stel hoog responsieve en schaalbare apps samen door alleen de gegevens te retourneren die een klant nodig heeft, en dat alles in één enkel verzoek. De GraphQL-API overkomt de uitdagingen waarmee de traditionele REST-API worstelen via veldselectie, resourceaggregatie en introspectie van schema's. Veldselectie reduceert de omvang van de belasting en stuurt alleen velden terug die in de query waren opgenomen. Aggregaties reduceren de reistijden tussen de client en de server waardoor een set gerelateerde resources binnen één enkele respons wordt teruggestuurd. Met schema-introspectie kan een gebruiker de typen, velden en objecten zien waartoe de gebruiker toegang heeft.

Zie de GraphQL API Developer Guide.

Wanneer gebruikt men de Tooling API?

Gebruik de Tooling API voor de integratie van Salesforce-metagegevens met andere systemen. Typen metagegevens worden zichtbaar als sObjects, zodat u toegang hebt tot één component van een complex type. Deze toegang op veldniveau versnelt bewerkingen voor complexe typen metagegevens. U kunt ook aangepaste ontwikkelingstools samenstellen voor Force.com-toepassingen. Gebruik de Tooling API bijvoorbeeld wanneer u werkende kopieën van Apex-klassen en -triggers en Visualforce-pagina's en -componenten wilt beheren en implementeren. U kunt ook controlepunten instellen van heapdumpmarkers, anonieme Apex uitvoeren en gegevens over vastleggen en codedekking openen.

REST en SOAP worden beide ondersteund.

Zie de Tooling API.

Wanneer gebruikt men Bulk-API 2.0?

Gebruik Bulk-API 2.0 om query's, queryAll of upsert-bewerkingen asynchroon uit te voeren op een groot aantal records of om een groot aantal records asynchroon in te voegen, bij te werken of te verwijderen Bulk-API 2.0 is ontwikkeld in het Salesforce REST-framework.

Elke gegevensbewerking die meer dan 2000 records verwerkt, is een goede kandidaat voor Bulk-API 2.0 voor het met succes voorbereiden, uitvoeren en beheren van een asynchrone werkstroom die gebruikmaakt van het Bulk-framework. Taken met minder dan 2000 records moeten bulkmatige synchrone aanroepen uitvoeren in REST (bijvoorbeeld Samengesteld) of SOAP.

Wanneer u met grote hoeveelheden gegevens werkt, is het het makkelijkst om records op schaal te maken, lezen, bijwerken en verwijderen (CRUD). Als uw taak slechts één type sObject omvat of maximaal 1 TB aan gegevens per dag extraheert, is Bulk-API 2.0 de meest geschikte Salesforce-API.

Zie de Bulk API 2.0 and Bulk API Developer Guide (Ontwikkelaarshandleiding voor Bulk-API 2.0 en Bulk-API).

Wanneer gebruikt men de API voor metagegevens?

Gebruik de API voor metagegevens voor het ophalen, implementeren, maken, bijwerken of verwijderen van aanpassingen voor uw organisatie. Het meest voorkomende gebruik is de migratie van wijzigingen van een sandbox- of testorganisatie naar uw productieomgeving. De API voor metagegevens is bedoeld voor het beheer van aanpassingen en het bouwen van tools die kunnen omgaan met het metagegevensmodel, niet de gegevens zelf.

De gemakkelijkste manier om toegang te krijgen tot de functionaliteit in de Metagegevens-API is de Salesforce-extensies voor Visual Studio Code of Salesforce CLI te gebruiken. Beide tools liggen als het ware boven op de Metagegevens-API en gebruiken de standaardtools om het werken met de Metagegevens-API te vereenvoudigen.

• De Salesforce-extensies voor Visual Studio Code omvatten tools voor ontwikkeling op het Salesforce-platform in de lichtgewicht, uitbreidbare VS Code-editor. Deze tools bieden voorzieningen voor het werken met ontwikkelingsorganisaties (scratch-organisaties, sandboxes en DE-organisaties), Apex, Aura-componenten en Visualforce.
• Salesforce CLI is ideaal als u een script of opdrachtregelhulpprogramma wilt gebruiken om metagegevens te verplaatsen tussen een lokale directory en een Salesforce-organisatie.

Zie de Metadata API Developer Guide (Ontwikkelaarshandleiding voor de metagegevens-API).

Wanneer gebruikt men de Pub/Sub-API?

U kunt de Pub/Sub-API gebruiken om externe systemen te integreren met events. Eventstromen zijn gebaseerd op aangepaste payloads via platform-events of wijzigingen in Salesforce-records via Vastleggen van gegevens wijzigen. In Salesforce kunt u events publiceren en u abonneren op events met Apex-triggers, Processamensteller en Flow Builder.

De Pub/Sub-API is ontwikkeld voor grootschalige bidirectionele eventintegratie met Salesforce. Gebruik de Pub/Sub-API om efficiënt binaire eventberichten te publiceren en u te abonneren op de Apache Avro-indeling. De Pub/Sub-API is gebaseerd op gRPC en HTTP/2 en gebruikt een op pull gebaseerd model zodat u de abonnementsstroom kunt sturen. Met de Pub/Sub-API kunt u een van de 11 programmeertalen gebruiken die door gRPC worden ondersteund.

Gebruik het type streamingevent dat aan uw behoeften voldoet.

• Event Gegevensvastlegging wijzigen: Ontvang wijzigingen in Salesforce-records met alle gewijzigde velden. Vastleggen van gegevens wijzigen ondersteunt meer standaardobjecten dan PushTopic-events en biedt meer functies, zoals koptekstvelden die informatie over de wijziging bevatten.
• Platform-event: Aangepaste payloads publiceren en ontvangen met een vooraf gedefinieerd schema. De gegevens kunnen alles zijn wat u definieert, inclusief bedrijfsgegevens, zoals ordergegevens. Geef de te verzenden gegevens op door een platformevent te definiëren. Abonneer u op een platformeventkanaal om meldingen te ontvangen.
• Verouderde events: PushTopic- en Generic-event: PushTopic en generieke events zijn events van de eerste generatie. Ze krijgen beperkte ondersteuning en worden niet langer bijgewerkt met nieuwe voorzieningen. U wordt aangeraden om events van Vastleggen van gegevens wijzigen te gebruiken in plaats van PushTopic-events en Platform-events te gebruiken in plaats van Generieke events.

Zie de Pub/Sub API-documentatie.