Какой API использовать?

Когда использовать REST API

REST API предоставляет мощный, удобный и простой интерфейс веб-служб на основе REST для взаимодействия с Salesforce. Его преимущества включают простоту интеграции и разработки, а также отличный выбор технологий для использования в мобильных приложениях и веб-проектах. Для определенных проектов можно использовать REST API с другими Salesforce REST API. Чтобы создать пользовательский интерфейс для создания, чтения, обновления и удаления записей, включая создание пользовательского интерфейса для списковых представлений, действий и зависимых раскрывающихся списков, используйте User Interface API. Чтобы создать пользовательский интерфейс для B2B Commerce в Lightning, управляемом содержимом CMS, сайтах Experience Cloud или Chatter, используйте Connect REST API. Если у вас много записей для обработки, рекомендуем использовать Bulk API, основанный на принципах REST и оптимизированный для больших наборов данных.

См. Руководство разработчика REST API.

Когда использовать SOAP API

SOAP API предоставляет мощный, удобный и простой интерфейс веб-служб на основе SOAP для взаимодействия с Salesforce. SOAP API можно использовать для создания, извлечения, обновления или удаления записей. Также можно использовать SOAP API для выполнения поиска и многого другого. Используйте SOAP API на любом языке, поддерживающем веб- службы.

Например, можно использовать SOAP API для интеграции Salesforce с ERP и финансовыми системами вашей организации. Можно также предоставлять сведения о продажах и поддержке в режиме реального времени на корпоративные порталы и заполнять важные бизнес-системы сведениями о клиентах.

См. Руководство разработчика SOAP API.

Когда использовать Connect REST API

Connect REST API предоставляет программный доступ к B2B Commerce для Lightning, управляемому содержимому CMS, сайтам Experience Cloud, файлам, уведомлениям, темам и прочему. Используйте Connect REST API для отображения лент Chatter, пользователей и групп, особенно в мобильных приложениях.

См. Руководство разработчика Connect REST API.

Когда использовать Apex REST API

Используйте Apex REST API, когда хотите открыть классы и методы Apex, чтобы внешние приложения могли получить доступ к коду посредством архитектуры REST. Apex REST API поддерживает OAuth 2.0 и код сеанса для авторизации.

См. Руководство разработчика Apex: Отображение классов Apex как REST Web Services.

Когда использовать Apex SOAP API

Используйте Apex SOAP API, если вы хотите отобразить методы Apex как API веб-службы SOAP, чтобы внешние приложения имели доступ к коду посредством SOAP.

Apex SOAP API поддерживает OAuth 2.0 и код сеанса для авторизации.

См. Руководство разработчика Apex: Представление методов Apex как веб-служб SOAP и руководства разработчика SOAP API: Вызовы, связанные с Apex.

Когда использовать Analytics REST API

Активы CRM Analytics, например, наборы данных, представления Lens и панели мониторинга, можно открыть программным способом посредством Analytics REST API. Отправляйте запросы и открывайте наборы данных, импортированные в аналитическую платформу. Создание и извлечение представлений Lens. Доступ к сведениям о XMD. Извлеките список версий набора данных. Создание и извлечение приложений CRM Analytics. Создание, обновление и извлечение панелей мониторинга. Извлеките список зависимостей для приложения. Определите функции, доступные пользователю. Работайте со снимками. Манипулирование реплицированными наборами данных.

См. Руководство разработчика Analytics REST API.

Когда использовать API пользовательского интерфейса

Создайте пользовательский интерфейс Salesforce для нативных мобильных приложений и настраиваемых веб-приложений, используя тот же API, который Salesforce использует для создания Lightning Experience и Salesforce для Android, iOS и мобильного веб. Создайте пользовательские интерфейсы, позволяющие пользователям работать с записями, списковыми представлениями, действиями, избранными и прочим. Вы не только получаете данные и метаданные в одном ответе, но и ответ соответствует изменениям метаданных, внесенным в организацию администраторами Salesforce. Макеты, раскрывающиеся списки, безопасность полей или общий доступ не волнуют — достаточно создать приложение, понравившееся пользователям.

См. Руководство разработчика пользовательского интерфейса API.

Когда использовать GraphQL API

Создавайте быстро реагирующие и масштабируемые приложения, возвращая только нужные клиенту данные, все в одном запросе. GraphQL API преодолевает проблемы, создаваемые традиционными REST API, посредством выбора поля, агрегации ресурсов и интроспекции схемы. Выбор поля уменьшает размер полезной нагрузки, отправляя обратно только поля, добавленные в запрос. Агрегации уменьшают круговые поездки между клиентом и сервером, возвращая набор связанных ресурсов в одном ответе. Интроспекция схемы позволяет пользователю видеть типы, поля и объекты, к которым у пользователя есть доступ.

См. Руководство разработчика GraphQL API.

Когда использовать Tooling API

Используйте Tooling API для интеграции метаданных Salesforce с другими системами. Типы метаданных открываются как sObjects, поэтому можно получить доступ к одному компоненту сложного типа. Этот доступ на уровне поля ускоряет операции над типами сложных метаданных. Можно также создать настраиваемые инструменты разработки для приложений Force.com. Например, используйте Tooling API для управления и развертывания рабочих копий классов и триггеров Apex и страниц и компонентов Visualforce. Можно также установить контрольные точки или маркеры кучного дампа, выполнить анонимный Apex и получить доступ к сведениям о регистрации и покрытии кода.

Поддерживаются REST и SOAP.

См. Tooling API.

Когда использовать Bulk API 2.0

Используйте Bulk API 2.0 для асинхронного запроса, queryAll, вставки, обновления, обновления или удаления большого количества записей. Bulk API 2.0 разработан на основе инфраструктуры Salesforce REST.

Любая операция над данными, содержащая более 2 000 записей, является хорошим кандидатом на успешное создание, выполнение и управление асинхронным бизнес-правилом, использующим инфраструктуру Bulk API 2.0. Лучше всего, если задания с менее 2 000 записей используют «пакетные» синхронные вызовы в REST (например, составной) или SOAP.

При работе с большими объемами данных это самый простой способ создания, чтения, обновления и удаления (CRUD) записей в масштабах. Если ваше задание содержит только один тип sObject или извлекает до 1 Тб данных в день, Bulk API 2.0 - это ваш выбор Salesforce API.

См. Руководство разработчика Bulk API 2.0 и Bulk API.

Когда использовать Metadata API

Используйте Metadata API для извлечения, развертывания, создания, обновления или удаления настроек организации. Наиболее распространенным способом является миграция изменений из безопасной среды или тестовой организации в производственную среду. Metadata API предназначен для управления настройками и создания инструментов, которые могут управлять моделью метаданных, а не самими данными.

Наиболее простым способом доступа к функциям в Metadata API является использование расширений Salesforce для Visual Studio Code или Salesforce CLI. Оба инструмента созданы на основе Metadata API и используют стандартные инструменты для упрощения работы с Metadata API.

• Расширения Salesforce для Visual Studio Code содержат инструменты для разработки на платформе Salesforce в облегченном расширяемом редакторе VS Code. Эти инструменты предоставляют функции для работы с организациями разработки (начальные организации, безопасные среды и организации DE), Apex, компонентами Aura и Visualforce.
• Salesforce CLI идеально подходит для использования сценария или командной строки при перемещении метаданных между локальным каталогом и организацией Salesforce.

См. Руководство разработчика метаданных API.

Когда использовать Public/Sub API

Вы можете использовать Public Sub API для интеграции внешних систем с событиями. Потоки событий основаны на настраиваемых полезных данных посредством событий платформы или изменений в записях Salesforce посредством сбора данных об изменении. В Salesforce можно публиковать и подписываться на события с помощью триггеров Apex, конструктора процессов и Flow Builder.

Pub/Sub API создан для интеграции крупномасштабных двусторонних событий с Salesforce. Используйте Public/Sub API для эффективной публикации и подписки на двоичные сообщения о событиях в формате Apache Avro. Pub/Sub API основан на gRPC и HTTP/2 и использует модель на основе извлечения, чтобы управлять потоком подписки. С помощью Public/Sub API можно использовать один из 11 языков программирования, поддерживаемых gRPC.

Используйте тип потокового события, соответствующий вашим потребностям.

• Событие сбора данных изменения: Получайте изменения в записях Salesforce со всеми измененными полями. Сбор данных об изменении поддерживает больше стандартных объектов, чем события PushTopic, и предоставляет больше функций, например, поля заголовка, содержащие сведения об изменении.
• Событие платформы: Публикация и получение настраиваемых полезных данных с предопределенной схемой. Данные могут быть любыми, включая бизнес-данные, например, сведения о заказе. Укажите данные для отправки, определив событие платформы. Подпишитесь на канал событий платформы для получения уведомлений.
• Устаревшие события: PushTopic и общее событие: PushTopic и общие события являются событиями первого поколения. Они имеют ограниченную поддержку и больше не обновляются новыми функциями. Рекомендуем использовать события сбора данных об изменении вместо событий PushTopic и событий платформы вместо общих событий.

См. документацию Public/Sub API.