Qual API eu uso?

Quando usar a API REST

Uma API REST oferece uma interface de serviços da Web baseada em REST avançada, conveniente e simples para interagir com o Salesforce. Suas vantagens incluem facilidade de integração e desenvolvimento. Uma excelente opção de tecnologia para uso com aplicativos móveis e projetos Web. Em alguns projetos, é possível usar a API REST com outras APIs REST do Salesforce. Para criar UI para criação, leitura, atualização e exclusão de registros, incluindo a criação de UI para modos de exibição de lista, ações e listas de opções dependentes, use a API da interface de usuário. Para criar a IU para o B2B Commerce no Lightning, conteúdo gerenciado do CMS, sites do Experience Cloud ou Chatter, use a API REST do Connect. Se houver muitos registros para processar, considere a possibilidade de usar a API em massa, que é baseada nos princípios do REST e otimizada para grandes conjuntos de dados.

Consulte o Guia do desenvolvedor da API REST.

Quando usar a API SOAP

Uma API SOAP oferece uma interface de serviços da Web baseada em SOAP avançada, conveniente e simples para interagir com o Salesforce. Pode-se usar a API SOAP para criar, recuperar, atualizar ou excluir registros. Você pode usar API SOAP para realizar pesquisas e muito mais. Use a API SOAP em qualquer idioma que suporte serviços da Web.

Por exemplo, você pode usar a API SOAP para integrar o Salesforce aos sistemas ERP e financeiros da sua organização. Também é possível fornecer informações de suporte e vendas em tempo real aos portais da empresa e preencher os sistemas comerciais essenciais com informações dos clientes.

Consulte o Guia do desenvolvedor da API SOAP do Salesforce.

Quando usar a API REST do Connect

A API REST do Connect fornece acesso programático ao B2B Commerce para Lightning, conteúdo gerenciado do CMS, sites do Experience Cloud, arquivos, notificações, tópicos e muito mais. Use a API REST do Connect para exibir feeds, usuários e grupos do Chatter, especialmente em aplicativos móveis.

Consulte o Guia do desenvolvedor da API REST do Connect.

Quando usar a API REST do Apex

Use a API REST do Apex quando quiser expor seus métodos e classes do Apex para que aplicativos externos possam acessar seu código por meio da arquitetura REST. A API REST do Apex oferece suporte a OAuth 2.0 e ID de sessão para autorização.

Consulte Guia do desenvolvedor do Apex: Expor classes do APEX como serviços REST da Web.

Quando usar a API SOAP do Apex

Use a API SOAP do Apex quando quiser expor métodos Apex como APIs de serviço SOAP da Web para que aplicativos externos possam acessar seu código por meio de SOAP.

A API SOAP do Apex oferece suporte a OAuth 2.0 e ID de sessão para autorização.

Consulte Guia do desenvolvedor do Apex: Expor métodos do Apex como serviços Web SOAP e Guia do desenvolvedor da API SOAP: Chamadas relacionadas ao Apex.

Quando usar a API REST do Analytics

Você pode acessar ativos do CRM Analytics, como conjuntos de dados, lenses e painéis, usando programaticamente a API REST do Analytics. Envie consultas e acesse conjuntos de dados importados para a plataforma de análise. Criar e recuperar lenses. Acesse informações do XMD. Recuperar uma lista de versões do conjunto de dados. Criar e recuperar aplicativos do CRM Analytics. Criar, atualizar e recuperar painéis. Recupere uma lista de dependências para um aplicativo. Determine quais recursos estão disponíveis ao usuário. Trabalhar com instantâneos. Manipule conjuntos de dados replicados.

Consulte o Guia do desenvolvedor da API REST do Analytics.

Quando usar a API da interface de usuário

Crie a UI do Salesforce para aplicativos móveis nativos e aplicativos da Web personalizados utilizando a mesma API que a Salesforce usa para desenvolver o Lightning Experience e o Salesforce para Android, iOS e Web móvel. Crie interfaces que permitem que os usuários trabalhem com registros, com modos de exibição de lista, com ações, com favoritos e mais. Além de você obter dados e metadados em uma única resposta, a resposta também corresponde a alterações nos metadados feitas na organização por administradores do Salesforce. Não se preocupe com layouts, listas de opções, segurança em nível de campo ou compartilhamento; tudo o que você precisa fazer é criar um aplicativo que os usuários adorem.

Consulte o Guia do desenvolvedor da API da interface de usuário.

Quando usar a API GraphQL

Crie aplicativos altamente responsivos e escalonáveis retornando apenas os dados de que um cliente precisa, tudo em uma só solicitação. A API GraphQL supervisiona os desafios apresentados pelas APIs REST tradicionais por meio de seleção de campo, agregação de recursos e introspecção de esquema. A seleção de campo reduz o tamanho da carga, enviando de volta apenas os campos incluídos na consulta. As agregações reduzem as viagens de ida e volta entre o cliente e o servidor, retornando um conjunto de recursos relacionados em uma só resposta. A introspecção do esquema permite que um usuário veja os tipos, os campos e os objetos aos quais o usuário tem acesso.

Consulte o Guia do desenvolvedor da API do GraphQL.

Quando usar a API do conjunto de ferramentas

Use a API do conjunto de ferramentas para integrar metadados do Salesforce a outros sistemas. Os tipos de metadados são expostos como sObjects para que você possa acessar um componente de um tipo complexo. Esse acesso em nível de campo acelera as operações com tipos de metadados complexos. Também é possível criar ferramentas de desenvolvimento personalizadas para aplicativos do Force.com. Por exemplo, use a API do conjunto de ferramentas para gerenciar e implantar cópias de trabalho de acionadores e classes do Apex e componentes e páginas do Visualforce. Você também pode definir pontos de verificação ou marcadores de heap dump, executar Apex anônimo e acessar informações de cobertura de código e registro.

Há suporte para REST e SOAP.

Consulte API de ferramentas.

Quando usar API 2.0 em massa

Use API 2.0 em massa para consultar, consultar tudo, inserir, atualizar, inserir e atualizar ou excluir um grande número de registros de forma assíncrona. API 2.0 em massa é projetada na estrutura REST do Salesforce.

Qualquer operação de dados que inclua mais de 2 mil registros é um bom candidato para a API em massa 2.0 para preparar, executar e gerenciar com sucesso um fluxo de trabalho assíncrono que usa a estrutura em massa. Os trabalhos com menos de 2 mil registros devem envolver chamadas síncronas "massificadas" em REST (por exemplo, Componente) ou SOAP.

Ao trabalhar com grandes volumes de dados, é a maneira mais fácil de criar, ler, atualizar e excluir (CRUD) registros em escala. Se o seu trabalho incluir apenas um tipo de sObject ou extrair até 1 TB de dados por dia, a API 2.0 em massa será a API de sua escolha do Salesforce.

Consulte o Guia do desenvolvedor da API em massa 2.0 e API em massa.

Quando usar a API de metadados

Use a API de metadados para recuperar, implantar, criar, atualizar ou excluir personalizações para a sua organização. O uso mais comum é migrar as alterações de um sandbox ou organização de teste para seu ambiente de produção. A API de metadados é destinada ao gerenciamento de personalizações e à criação de ferramentas que podem gerenciar o modelo de metadados, não os próprios dados.

A forma mais fácil de acessar a funcionalidade na API de metadados é usar as Extensões do Salesforce para Visual Studio Code ou Salesforce CLI. Ambas as ferramentas são construídas com base na API de metadados e usam as ferramentas padrão para simplificar o trabalho com a API de metadados.

• A Extensões do Salesforce para Visual Studio Code inclui ferramentas para desenvolver na Salesforce Platform no editor do VS Code leve e extensível. Essas ferramentas fornecem recursos para trabalhar com organizações de desenvolvimento (organizações teste, sandboxes e organizações DE), Apex, componentes do Aura e Visualforce.
• O Salesforce CLI é ideal se você usa um script ou linha de comando para mover metadados entre um diretório local e uma organização do Salesforce.

Consulte o Guia do desenvolvedor da API de metadados.

Quando usar a API Pub/Sub

Você pode usar a API Pub/Sub para integrar sistemas externos a eventos. Os fluxos de evento são baseados em cargas úteis personalizadas por meio de eventos de plataforma ou alterações em registros do Salesforce por meio da Captura de dados de alteração. No Salesforce, você pode publicar e assinar eventos com acionadores do Apex, Criador de processos e Flow Builder.

A API Pub/Sub é criada para integração de evento bidirecional de alta escala com o Salesforce. Use a API Pub/Sub para publicar e assinar de modo eficiente mensagens de evento binárias no formato Apache Avro. A API Pub/Sub é baseada em gRPC e HTTP/2 e usa um modelo baseado em pull para que você possa controlar o fluxo de assinatura. Com a API Pub/Sub, você pode usar uma das 11 idiomas de programação compatíveis com gRPC.

Use o tipo de evento de streaming que atende às suas necessidades.

• Evento de Captura de Dados de Alteração: Receba alterações em registros do Salesforce com todos os campos alterados. A Captura de Alteração de Dados oferece suporte a mais objetos padrão do que os eventos PushTopic e fornece mais recursos, como campos de cabeçalho que contêm informações sobre a alteração.
• Eventos de plataforma: Publique e receba recursos específicos personalizados com um esquema predefinido. Os dados podem ser qualquer coisa que você defina, incluindo dados comerciais, como informações de pedidos. Especifique os dados a enviar definindo um evento de plataforma. Inscreva-se em um canal de evento de plataforma para receber notificações.
• Eventos legados: Eventos PushTopic e genéricos: Eventos PushTopic e genéricos são eventos de primeira geração. Eles têm suporte limitado e não são mais atualizados com novos recursos. Recomendamos usar os eventos de Captura de alteração de dados em vez de eventos PushTopic e eventos da plataforma, em vez de eventos genéricos.

Consulte a documentação da API Pub/Sub.