API da utilizzare

Quando utilizzare l'API REST

L'API REST offre un'interfaccia di servizi Web REST efficace, pratica e semplice per l'interazione con Salesforce. L'interfaccia offre vantaggi quali la semplicità di integrazione e sviluppo ed è una tecnologia eccellente per l'utilizzo con le applicazioni mobili e i progetti Web. Per alcuni progetti, si può utilizzare l'API REST con altre API REST Salesforce. Per compilare l'interfaccia utente per creare, leggere, aggiornare ed eliminare i record, inclusa la compilazione dell'interfaccia utente per visualizzazioni elenco, azioni ed elenchi di selezione dipendenti, utilizzare l'API dell'interfaccia utente. Per compilare l'interfaccia utente per B2B Commerce in Lightning, nel contenuto CMS gestito, nei siti Experience Cloud o in Chatter, utilizzare l'API REST Connect. In presenza di molti record da elaborare, considerare l'uso dell'API in blocco, basata sui principi REST e ottimizzata per serie di dati di grandi dimensioni.

Vedere REST API Developer Guide.

Quando utilizzare l'API SOAP

L'API SOAP offre un'interfaccia di servizi Web SOAP efficace, pratica e semplice per l'interazione con Salesforce. Per creare, recuperare, aggiornare o eliminare record è possibile utilizzare l'API SOAP. È inoltre possibile utilizzare l'API SOAP per eseguire ricerche e molto altro. L'API SOAP si può utilizzare in tutte le lingue che supportano i servizi Web.

Ad esempio, è possibile utilizzare l'API SOAP per integrare Salesforce con i sistemi ERP e finanziari dell'organizzazione. Inoltre, è possibile fornire informazioni in tempo reale su vendita e assistenza ai portali della società e popolare i sistemi aziendali critici con le informazioni sui clienti.

Vedere SOAP API Developer Guide.

Quando utilizzare l'API REST Connect

L'API REST Connect fornisce l'accesso a livello di codice a B2B Commerce per Lightning, contenuto CMS gestito, siti Experience Cloud, file, notifiche, argomenti e altro ancora. Utilizzare l'API REST Connect per visualizzare feed, utenti e gruppi di Chatter, in particolare nelle applicazioni mobili.

Vedere Connect REST API Developer Guide.

Quando utilizzare l'API REST Apex

Utilizzare l'API REST Apex quando si desidera esporre le classi e i metodi Apex per consentire alle applicazioni esterne di accedere al codice tramite l'architettura REST. L'API REST Apex supporta OAuth 2.0 e ID sessione per l'autorizzazione.

Vedere Apex Developer Guide: Exposing Apex Classes as REST Web Services.

Quando utilizzare l'API SOAP Apex

Utilizzare l'API SOAP Apex quando si desidera esporre i metodi Apex come API del servizio Web SOAP per consentire alle applicazioni esterne di accedere al codice tramite SOAP.

L'API SOAP Apex supporta OAuth 2.0 e ID sessione per l'autorizzazione.

Vedere Apex Developer Guide: Exposing Apex Methods as SOAP Web Services and SOAP API Developer Guide: Apex-Related Calls.

Quando utilizzare l'API REST Analytics

È possibile accedere agli asset CRM Analytics, ad esempio alle serie di dati, alle lenti e ai cruscotti digitali, a livello di programmazione mediante l'API REST Analytics. Inviare query e accedere alle serie di dati importate nella piattaforma Analytics. Creare e recuperare lenti. Accedere alle informazioni XMD. Recuperare un elenco delle versioni della serie di dati. Creare e recuperare le app di CRM Analytics. Creare, aggiornare e recuperare cruscotti digitali. Recuperare un elenco di dipendenze per un'applicazione. Individuare le funzionalità disponibili per l'utente. Utilizzare le istantanee. Manipolare le serie di dati replicate.

Vedere Analytics REST API Developer Guide.

Quando utilizzare l'API dell'interfaccia utente

Compilare l'interfaccia utente di Salesforce per le applicazioni mobili native e per le applicazioni Web personalizzate utilizzando la stessa API utilizzata da Salesforce per la compilazione di Lightning Experience, Salesforce per Android, iOS e mobile web. Creare interfacce utente che consentono agli utenti di utilizzare record, visualizzazioni elenco, azioni, preferiti e altro. In questo modo non solo sarà possibile ottenere i dati e i metadati in un'unica risposta, ma la risposta rifletterà le modifiche ai metadati apportate all'organizzazione dagli amministratori Salesforce. Non preoccuparsi di layout, elenchi di selezione, protezione a livello di campo o condivisione: l'importante è creare un'applicazione che piaccia agli utenti.

Vedere User Interface API Developer Guide.

Quando utilizzare l'API GraphQL

È possibile creare app altamente reattive e scalabili restituendo solo i dati di cui ha bisogno un cliente, tutto in un'unica richiesta. L'API GraphQL supera le sfide presentate dalle vecchie API REST tramite la selezione dei campi, l'aggregazione delle risorse e l'introspezione dello schema. La selezione dei campi riduce le dimensioni del payload, inviando solo i campi che erano inclusi nella query. Le aggregazioni riducono i round trip tra il client e il server, restituendo una serie di risorse correlate all'interno di una singola risposta. L'introspezione dello schema consente a un utente di visualizzare i tipi, i campi e gli oggetti a cui l'utente ha accesso.

Vedere GraphQL API Developer Guide.

Quando utilizzare Tooling API

Utilizzare Tooling API per integrare i metadati di Salesforce con altri sistemi. I tipi di metadati sono esposti come sObject, quindi è possibile accedere a un componente di un tipo complesso. L'accesso a livello di campo accelera le operazioni eseguite sui tipi complessi di metadati. È inoltre possibile creare strumenti di sviluppo per le applicazioni Force.com. Ad esempio, utilizzare Tooling API per gestire e distribuire copie funzionanti di classi e trigger Apex e pagine e componenti Visualforce. Inoltre, è possibile impostare checkpoint o indicatori degli heap dump, eseguire Apex anonimo e accedere alle informazioni su accesso e copertura del codice.

REST e SOAP sono entrambi supportati.

Vedere Tooling API.

Quando utilizzare l'API in blocco 2.0

Utilizzare l'API in blocco 2.0 per eseguire query, eseguire chiamate queryAll, inserire, aggiornare, inserire con aggiornamento o eliminare molti record in modo asincrono. L'API in blocco 2.0 è basata sul framework REST Salesforce.

Qualsiasi operazione sui dati che include più di 2.000 record è un buon candidato per l'API in blocco 2.0 per preparare, eseguire e gestire correttamente un flusso di lavoro asincrono che utilizzi il framework in blocco. I processi con meno di 2.000 record devono includere chiamate sincronizzate "eseguite in blocco" in REST (ad esempio, Composite) o SOAP.

Quando si utilizzano volumi elevati di dati, è il modo più semplice per eseguire operazioni CRUD (Create, Read, Update e Disable) sui record su larga scala. Se il processo include solo un tipo di sObject o estrae fino a 1 TB dati al giorno, l'API in blocco 2.0 è l'API Salesforce preferita.

Vedere Bulk API 2.0 and Bulk API Developer Guide.

Quando utilizzare l'API dei metadati

Utilizzare l'API dei metadati per recuperare, distribuire, creare, aggiornare ed eliminare personalizzazioni per la propria organizzazione. L'impiego più comune consiste nel migrare le modifiche da un'organizzazione Sandbox o di prova all'ambiente di produzione. L'API dei metadati è progettata per la gestione delle personalizzazioni e per la creazione di strumenti in grado di gestire il modello dei metadati, non i dati stessi.

La soluzione più semplice per accedere alla funzionalità nell'API metadati è utilizzare le estensioni Salesforce per Visual Studio Code o Salesforce CLI. Entrambi gli strumenti sono basati sull'API metadati e utilizzano strumenti standard per semplificare l'utilizzo dell'API metadati.

• Le estensioni Salesforce per Visual Studio Code includono strumenti per lo sviluppo sulla piattaforma Salesforce con il leggero e ampliabile editor di VS Code. Questi strumenti offrono funzioni per l'uso delle organizzazioni di sviluppo (organizzazioni vuote, Sandbox e DE), Apex, componenti Aura e Visualforce.
• Salesforce CLI è l'ideale se si utilizza uno script o la riga di comando per spostare i metadati tra una directory locale e un'organizzazione Salesforce.

Vedere Metadata API Developer Guide.

Quando utilizzare l'API Pub/Sub

È possibile utilizzare l'API Pub/Sub per integrare i sistemi esterni con gli eventi. Gli stream degli eventi si basano sui payload personalizzati attraverso gli eventi piattaforma o le modifiche ai record Salesforce tramite l'acquisizione dei dati di modifica. In Salesforce è possibile pubblicare e abbonarsi agli eventi con trigger Apex, Process Builder e Flow Builder.

L'API Pub/Sub è configurata per l'integrazione bidirezionale degli eventi su larga scala con Salesforce. Utilizzare l'API Pub/Sub per pubblicare e abbonarsi in modo efficiente ai messaggi di eventi binari nel formato Apache Avro. L'API Pub/Sub è basata su gRPC e HTTP/2 e utilizza un modello pull-based per consentire il controllo del flusso di abbonamento. Con l'API Pub/Sub è possibile utilizzare una delle 11 lingue di programmazione supportate da gRPC.

Utilizzare il tipo di evento di streaming più adatto alle proprie esigenze.

• Evento Acquisizione dati modifica: Ricevere le modifiche ai record Salesforce con tutti i campi modificati. L'evento Acquisizione dati di modifica supporta più oggetti standard rispetto all'evento PushTopic e offre un maggior numero di funzioni, ad esempio i campi di intestazione contenenti informazioni sulla modifica.
• Evento piattaforma: Pubblicare e ricevere i payload personalizzati con uno schema predefinito. I dati possono essere costituiti da qualsiasi tipo di dati, inclusi i dati aziendali, ad esempio le informazioni sugli ordini. Specificare i dati da inviare definendo un evento piattaforma. Iscriversi a un canale di eventi piattaforma per ricevere le notifiche.
• Eventi legacy: Evento PushTopic e generico: Gli eventi PushTopic e generici sono eventi di prima generazione. Sono disponibili con un supporto limitato e non vengono più aggiornati con le nuove funzioni. Si consiglia di utilizzare gli eventi Acquisizione dati di modifica anziché gli eventi PushTopic e gli eventi piattaforma anziché gli eventi generici.

Vedere la documentazione dell'API Pub/Sub.