Conheça as APIs da Salesforce Lightning Platform

Objetivos de aprendizagem

Após concluir esta unidade, você estará apto a:
  • Descrever os benefícios da abordagem de desenvolvimento API First.
  • Estabelecer casos de uso para API REST, API SOAP, API em massa e API de transmissão.
  • Indicar os dois tipos de limites de API e descrever como eles são calculados.

API First no Salesforce

Olá, marujo! Está pronto para começar a navegar em alto-mar em busca da API do Salesforce perfeita para a integração que você está criando? Muito bem, capitão, pegue seu tapa-olho e arranje um papagaio. Você está prestes a navegar pelas águas da Lightning Platform e aprender tudo sobre nossas APIs.

O panorama de APIs do Salesforce é tão vasto quanto o azul do oceano. Isso é porque o Salesforce adota uma abordagem API First para criar recursos na Salesforce Platform. A abordagem API First consiste em criar uma API robusta para um recurso antes de focar no desenvolvimento da respectiva interface de usuário. Essa abordagem oferece a você, o desenvolvedor do Salesforce, flexibilidade para manipular seus dados como quiser.

O Salesforce sabe que seus clientes e parceiros estão sempre pensando em novas formas de estender a funcionalidade do Salesforce e em aplicativos empolgantes a criar para o AppExchange. O fornecimento de uma caixa de ferramentas abrangente para desenvolvimento na plataforma é de grande importância. Essa abordagem permite também ao Salesforce criar interfaces de usuário sobre as APIs, garantindo assim que o comportamento seja o mesmo entre elas.

Pense neste módulo como sua companheira API First. Vamos juntos percorrer algumas informações gerais de API, realizar uma pesquisa sobre o conjunto de APIs do Salesforce e nos aprofundarmos sobre como usar algumas APIs comuns. Todas essas informações vão dar a você o conhecimento necessário para escolher a API certa para seu projeto.

APIs de dados do Salesforce

No mar das APIs do Salesforce, há um arquipélago principal de APIs normalmente usadas no qual nos concentramos neste módulo. São elas: API REST, API SOAP, API em massa e API de transmissão. Juntas, elas formam as APIs de dados do Salesforce. Seu propósito é permitir manipular seus dados do Salesforce, enquanto outras APIs permitem fazer coisas como layouts de página ou criar ferramentas de desenvolvimento personalizadas. Você pode usar outras APIs do Salesforce para manipular subconjuntos de seus dados do Salesforce também. Por exemplo, a API REST do Analytics se concentra no Analytics. Mas essas quatro APIs aplicam-se amplamente ao espectro de dados principais do Salesforce.
APIs de dados do Salesforce

REST API

A API REST é um serviço web simples e poderoso baseado em princípios RESTful. Expõe todo o tipo de funcionalidades do Salesforce por meio de recursos REST e métodos HTTP. Por exemplo, você pode criar, ler, atualizar e excluir (CRUD) registros, pesquisar ou consultar seus dados, obter metadados de objeto e acessar informações sobre limites em sua organização. A API REST aceita tanto XML quanto JSON.

Uma vez que a API REST tem uma estrutura de solicitações e respostas leve (além de ser fácil de usar), ela é excelente para escrever aplicativos móveis e aplicativos da web.

API SOAP

A API SOAP é um serviço web robusto e poderoso baseado no protocolo padrão do setor com o mesmo nome. Usa um arquivo WSDL (Web Services Description Language, Linguagem de Descrição de Serviços Web) para definir rigorosamente os parâmetros de acesso de dados por meio da API. A API SOAP aceita apenas XML. A maior parte da funcionalidade API SOAP está também disponível por meio da API REST. Depende apenas de qual padrão atende melhor as suas necessidades.

Uma vez que a API SOAP usa o arquivo WSDL como um contrato formal entre a API e o consumidor, ela é excelente para escrever integrações entre servidores.

API em massa

A API em massa é uma API RESTful especializada para carregar e consultar muitos dados de uma vez. Nesse contexto, “muitos” quer dizer 50.000 registros ou mais. A API em massa é assíncrona, ou seja, você pode enviar uma solicitação e voltar depois para ver os resultados. Essa abordagem é a preferida quando lidamos com uma grande quantidade de dados. Existem duas versões da API em massa (1.0 e 2.0). As duas versões lidam com grandes quantidades de dados, mas usamos a API em massa 2.0 neste módulo porque ela é mais fácil de usar.

A API em massa é ótima para realizar tarefas que envolvam muitos registros, tais como carregar dados para sua organização pela primeira vez.

API de transmissão

A API de transmissão é uma API especializada para configuração de notificações que são exibidas quando alterações são feitas em seus dados. Ela usa um modelo de publicação-assinatura, ou pub/sub, no qual os usuários podem assinar canais que transmitem certos tipos de alterações de dados.

O modelo pub/sub reduz o número de solicitações de API ao eliminar a necessidade de sondagem. A API de transmissão é excelente para escrever aplicativos que precisariam, de outro modo, sondar alterações frequentemente.

Acesso e autenticação de API

Você não precisa de um mapa do tesouro para acessar as APIs do Salesforce. Tudo o que você precisa é de um Trailhead Playground ou de uma organização em uma das seguintes edições: Enterprise Edition, Unlimited Edition, Developer Edition, Performance Edition ou Professional Edition (com complemento). Certifique-se de que você tem a permissão “API ativada” e que está pronto para começar a integrar.

Todas as chamadas de API, exceto a chamada login() da API SOAP, precisam de autenticação. Você pode usar um dos fluxos OAuth suportados ou autenticar com uma ID de sessão recuperada da chamada login() da API SOAP. Consulte o guia do desenvolvedor para saber mais sobre a API que escolheu para começar.

Limites de API

Qualquer capitão que se preze sabe quando impor limites à sua tripulação para o bem da embarcação. Se o capitão deixa os marinheiros encherem a cara durante todo o dia, fica tudo por fazer. Da mesma forma, o Salesforce limita o número de chamadas de API por organização para garantir a integridade da instância. Esses limites existem para evitar que scripts potencialmente perigosos deem cabo de nossos servidores. Eles não perturbam seu trabalho cotidiano. Ainda assim, é uma boa ideia se familiarizar com eles.

Há dois tipos de limites de API. Os limites concomitantes restringem o número de chamadas de longa duração (20 segundos ou mais longas) que estão ocorrendo simultaneamente. Os limites totais restringem o número de chamadas feitas dentro de um período contínuo de 24 horas.

Os limites concomitantes variam por tipo de organização. Para um Trailhead Playground, o limite é cinco chamadas de longa duração de uma vez. Para uma organização de sandbox, são 25 chamadas de longa duração.

Os limites totais variam dependendo da edição da organização, tipo de licença e pacotes de expansão que você compra. Por exemplo, uma organização Enterprise Edition recebe 1.000 chamadas por licença do Salesforce e 200 chamadas por licença de comunidade de parceiros. Com um pacote de “Chamadas de API adicionais”, a mesma organização Enterprise Edition recebe um adicional de 4.000 chamadas. Os limites totais são ainda sujeitos a mínimos e máximos com base na edição da organização, mas não vamos abordar isso agora. Se você quiser saber mais, confira o link Referência rápida de limites e alocações de desenvolvedor do Salesforce na seção Recursos.

Você tem várias maneiras de verificar suas chamadas de API restantes.
  • A caixa de uso da API na página Visão geral do sistema. (Em Configuração, insira Visão geral do sistema na caixa Busca rápida e selecione Visão geral do sistema.)
  • Informações retornadas no cabeçalho de resposta Sforce-Limit-Info para APIs REST.
  • Informações retornadas no corpo da resposta (em <type>API REQUESTS</type>) para APIs SOAP.
  • A chamada /limits na API REST da Lightning Platform.
  • O limite de solicitações à API por direito baseado em uso mensal, que mostra a você as chamadas de API da sua organização no período de 30 dias.
Você pode ainda configurar notificações para quando sua organização excede um número de chamadas de API que você determina. Para fazer isso, em Configuração, insira Notificações de uso da API na caixa Busca rápida e selecione Notificações de uso da API.

Qual API eu uso?

Escolher a API certa para suas necessidades de integração é uma decisão importante. Aqui estão algumas informações sobre nossas APIs mais usadas, incluindo protocolos suportados, formatos de dados, paradigmas de comunicação e casos de uso. Tenha esta seção como uma referência à qual você pode recorrer quando estiver considerando qual API usar.

Observe as quatro APIs de dados das quais já falamos. Vamos nos aprofundar em cada uma delas a seguir.

Nome da API Protocolo Formato de dados Comunicação
REST API REST JSON, XML Síncrona
API SOAP SOAP (WSDL) XML Síncrona
API REST do Chatter REST JSON, XML Síncrona (fotos são processadas de forma assíncrona)
API de interface de usuário REST JSON Síncrona
API REST do Analytics REST JSON, XML Síncrona
API em massa REST CSV, JSON, XML Assíncrona
API de metadados SOAP (WSDL) XML Assíncrona
API de transmissão Bayeux JSON Assíncrona (transmissão de dados)
API REST do Apex REST JSON, XML, personalizado Síncrona
API SOAP do Apex SOAP (WSDL) XML Síncrona
API de ferramentas REST ou SOAP (WSDL) JSON, XML, personalizado Síncrona

Quando usar a API REST

A API REST fornece uma interface de serviços Web poderosa, conveniente e simples baseada em REST para interação com o Salesforce. Suas vantagens incluem facilidade de integração e desenvolvimento, além de ser uma excelente escolha de tecnologia para ser usada com aplicativos móveis e projetos Web. Para alguns projetos, talvez seja melhor usar a API REST com outras APIs REST do Salesforce. Para criar uma interface de usuário que crie, leia, atualize e exclua registros, incluindo a criação de Interface de usuário para modos de exibição de lista, ações e listas de opções dependentes, use a API de interface de usuário. Para criar uma interface de usuário para o Chatter, para as comunidades ou para recomendações, use a API REST do Chatter. Se você tem muitos registros para processar, considere usar a API em massa, que é baseada em princípios REST e otimizada para grandes conjuntos de dados.

Quando usar a API SOAP

A API SOAP fornece uma interface de serviços Web poderosa, conveniente e simples baseada em SOAP para interação com o Salesforce. Você pode usar a API SOAP para criar, recuperar, atualizar ou excluir registros. Você também pode usar a API SOAP para realizar pesquisas e muito mais. Use a API SOAP em qualquer linguagem que suporte serviços Web.

Por exemplo, você pode usar a API SOAP para integrar o Salesforce com o ERP e sistemas financeiros da sua organização. Você também pode fornecer vendas e informações de suporte em tempo real para portais de empresas e preencher sistemas comerciais importantes com informações de clientes.

Quando usar a API REST do Chatter

Use a API REST do Chatter para exibir feeds do Chatter, usuários, grupos e seguidores, especialmente em aplicativos móveis. A API REST do Chatter também dá acesso programático a arquivos, recomendações, tópicos, notificações, compras do Data.com e muito mais. A API REST do Chatter é semelhante às APIs oferecidas por outras empresas com feeds, como Facebook e Twitter, mas também expõe os recursos do Salesforce para além do Chatter.

Quando usar a API de interface de usuário

Crie uma interface de usuário do Salesforce para aplicativos móveis nativos e aplicativos da web personalizados usando a mesma API que a Salesforce usa para criar o Lightning Experience e o Salesforce para Android, iOS e web móvel. Crie interfaces de usuário que permitem aos usuários trabalhar com registros, modos de exibição de lista, ações, favoritos e muito mais. Não só você receberá dados e metadados em uma mesma resposta, como também a resposta refletirá as alterações de metadados feitas na organização pelos administradores do Salesforce. Não se preocupe com layouts, listas de opções, segurança em nível de campo ou compartilhamento; concentre-se em criar um aplicativo que os usuários amam.

Quando usar a API REST do Analytics

Você pode acessar ativos do Analytics, como conjuntos de dados, lenses e painéis, programaticamente usando a API REST do Analytics. Envie consultas diretamente para a plataforma Analytics. Acesse conjuntos de dados que foram importados para a plataforma Analytics. Crie e recupere lenses. Acesse informações XMD. Recupere uma lista de versões de conjunto de dados. Crie e recupere aplicativos do Analytics. Crie, atualize e recupere painéis do Analytics. Recupere uma lista de dependências de um aplicativo. Determine quais recursos estão disponíveis para o usuário. Trabalhe com instantâneos. Manipule conjuntos de dados replicados.

Quando usar a API em massa

A API em massa é baseada em princípios REST e é otimizada para carregar ou excluir grandes conjuntos de dados. Você pode usá-la para consultar, queryAll, inserir, atualizar, inserir e atualizar ou excluir muitos registros de forma assíncrona enviando lotes. O Salesforce processa lotes em segundo plano.

Por outro lado, a API SOAP é otimizada para aplicativos cliente em tempo real que atualizam alguns registros por vez. Você pode usar a API SOAP para processar muitos registros mas, quando os conjuntos de dados contêm centenas de milhares de registros, ela é menos prática. A API em massa é desenvolvida para facilitar o processamento de dados de alguns milhares até milhões de registros.

A forma mais fácil de usar a API em massa é habilitá-la para processar registros no Data Loader usando arquivos CSV. Usar o Data Loader evita a necessidade de escrever seu próprio aplicativo cliente.

Quando usar a API de metadados

Use a API de metadados para recuperar, implantar, criar, atualizar ou excluir personalizações para sua organização. O uso mais comum é migrar alterações de uma sandbox ou organização de teste para seu ambiente de produção. A API de metadados é concebida para gerenciar personalizações e para criar ferramentas que possam gerenciar o modelo de metadados e não os dados em si.

A maneira mais fácil de acessar a funcionalidade na API de metadados é usar Extensões do Salesforce para Visual Studio Code ou a ferramenta de migração Ant. Ambas as ferramentas são criadas com base na API de metadados e usam as ferramentas padrão para simplificar o trabalho com a API de metadados.
  • Extensões do Salesforce para Visual Studio Code inclui ferramentas para desenvolvimento na Salesforce Platform, no editor leve e extensível VS Code. Essas ferramentas fornecem recursos para trabalhar com organizações de desenvolvimento (organizações temporárias, sandboxes e organizações DE), Apex, componentes do Aura e Visualforce.
  • A Ferramenta de migração Ant é ideal se você usar um script ou a linha de comando para mover metadados entre um diretório local e uma organização do Salesforce.

Quando usar a API de transmissão

Use a API de Streaming para receber em tempo quase real fluxos de dados que são baseadas em mudanças nos registros do Salesforce ou carga útil personalizada. Para mudanças de registro do Salesforce, o Salesforce publica notificações quando as mudanças ocorrem. Para notificações personalizadas, você pode publicar mensagens de evento. Os assinantes podem receber notificações usando CometD – uma implementação do protocolo de Bayeux que simula a tecnologia push. Os clientes podem também inscrever-se em alguns tipos de eventos com acionadores do Apex ou declarativamente com o Process Builder e o Flow Builder.

Use o tipo de evento de transmissão que se adapte às suas necessidades.

Evento PushTopic Receba as alterações do Salesforce com base em uma consulta SOQL que você define. As notificações incluem apenas os campos que você especificar na consulta de SOQL. Alterar evento de captura de dados Receba as alterações aos registros do Salesforce com todos os campos alterados. Alterar captura de dados é compatível com mais objetos padrão que os eventos PushTopic e oferece mais recursos, como campos de cabeçalho que contenham informações sobre a alteração. Evento de plataforma Publique e receba cargas personalizadas com um esquema predefinido. Os dados podem ser qualquer coisa que você definir, incluindo dados de negócios, tais como o pedido de informações. Especifique os dados a enviar definindo um evento de plataforma. Assine um canal de evento de plataforma para receber notificações. Evento genérico Publique e receba cargas arbitrárias sem um esquema definido.

Quando usar a API REST do Apex

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

Quando usar a API SOAP do Apex

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

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

Quando usar a API de ferramentas

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

REST e SOAP são ambas suportadas.

Continue a aprender de graça!
Inscreva-se em uma conta para continuar.
O que você ganha com isso?
  • Receba recomendações personalizadas para suas metas de carreira
  • Pratique suas habilidades com desafios práticos e testes
  • Monitore e compartilhe seu progresso com os empregadores
  • Conecte-se a orientação e oportunidades de carreira