Прекращение поддержки версий Salesforce Platform API 21.0—30.0

Дата первой публикации - 20 октября 2020 г.

Обновлено 4 марта 2024 года
 

Какой статус версий 21-30 SOAP, REST и Bulk API?

• Текущий: Данные версии API не рекомендуются (с выпуска Summer ‘22) и больше не поддерживаются. Вы можете их использовать, но при возникновении ошибок и регистрации обращения к службе поддержки Salesforce, сперва следует обновить версию API. Устранение неполадок и исправление ошибок устаревших версий API не предусмотрено.

• Будущие: Версия Summer ‘25– Данные версии API будут выведены из эксплуатации. Работа приложений, которые используют версии, будет нарушена, поскольку вызовы не выполняются и возвращают ошибку, что нужная конечная точка не найдена и не может быть обработана платформой. Ниже указаны ошибки:

  • REST API возвращает 410: GONE.

  • SOAP API возвращает 500: UNSUPPORTED_API_VERSION.

  • Bulk API возвращает 400: InvalidVersion.

Примечание: Версии API 7.0 - 20.0 уже не поддерживаются и недоступны в выпуске Summer ’22.

Почему прекращается поддержка версий API?
В настоящее время компания Salesforce активно работает над развитием последних версий API для расширения общих функциональных возможностей Salesforce при разработке настраиваемых функций посредством приложений. С целью изучения перспективы была использована версия API 30 с выпуска Spring ‘14.

На что влияет прекращение поддержки данной версии API?
Данное прекращение поддержки влияет на любой код, пакет, приложение или интеграцию, выполняющие запрос версий 21.0 - 30.0 SOAP, REST или Bulk API. 

Примечание! Данное прекращение поддержки не влияет на указанные ниже:

• Версии API классов Apex, триггеров Apex, страниц Visualforce, потоков и конструкторов процессов

• Готовый продукт B2B Classic/Visualforce

• Версированные компоненты метаданных в управляемом пакете

• Настраиваемые веб-службы Apex REST и SOAP (Настраиваемая веб-служба Apex делает метод класса Apex вызываемым в качестве общедоступного API. Дополнительную информацию о веб-службах Apex см. здесь: Веб-службы Apex) 

Что необходимо сделать?

1. Определите все компоненты/приложения в организации, которые используют устаревшие версии API.

2. Обновите эти компоненты/приложения. До выпуска Summer '25 вам следует изменить или обновить приложения с помощью текущей поддерживаемой версии API. Salesforce настоятельно рекомендует переход на более новые версии интерфейсов API, так как они предоставляют расширенные возможности и повышенную безопасность и производительность.

См. таблицы ниже, чтобы определить распространенные области влияния и действия, которые следует предпринять:

Как определить использование устаревших версий Версии API в моих приложениях?

Обратитесь к разработчикам используемых приложений для определения версий API.

Кроме того, можно просмотреть события API в бесплатном журнале API Total Usage EventLogFile с действиями SOAP, REST и Bulk API в Salesforce, используя один из указанных двух методов.

1. Первый метод: использовать новый обозреватель журнала событий, входящий в выпуск Summer ‘24.  Таким образом возможно осуществление поиска файлов журнала событий общего использования API по вашей организации и скачивание их как файлов CSV для просмотра отдельных событий API.  

В настройке выполните переход: Безопасность → Отслеживание событий → Обозреватель журнала событий.  Здесь можно просмотреть файлы журналов событий за последние 24 часа (или последние 30 дней, в случае активации отслеживания событий).  Потом можно скачать файлы отдельных журналов событий как файлы CSV для просмотра событий API.

2. В качестве альтернативы возможно использование такого клиента, как Salesforce CLI для выполнения запроса SOQL к объекту EventLogFile с целью получения файлов журнала действий за последние 24 часа (или 30 дней, если вы активировали Отслеживание событий).

sf data query -q "SELECT Id, LogFile, EventType, CreatedDate FROM EventLogFile WHERE EventType IN ('ApiTotalUsage')" -o <your-username>

Выполните запрос REST API для каждого результата. Воспользуйтесь конечными точками в результате запроса для получения данных журнала событий в этом файле журнала событий*.

/services/data/v58.0/sobjects/EventLogFile/0AT3i000005vXpWGAU/LogFile

Вставьте текст ответа в приложение для удобного просмотра данных журнала событий в виде CSV-файла.

3. Просмотрите каждый CSV-файл и определите, выполняются ли запросы на конечные точки, которые используют API версии 30 и ниже.

Просмотрите все события общего использования API (ApiTotalUsage EventType) с версией API_VERSION 30 и ниже**

4. Для всех интеграций или клиентов, которые используют версии 30.0 и ниже, выполните данные рекомендации, предоставленные ключевыми полями в данных журнала событий для определения источника вызова устаревших API:

CLIENT_NAME, CONNECTED_APP_ID, ENTITY_NAME, USER_ID

Для получения дополнительной информации об отслеживании событий пройдите модуль Trailhead Отслеживание событий.

*Для получения вступительной информации о выполнении запроса REST API см. данный trailhead Use REST API.

**Тип события "Общее использование API" объединяет актуальные сведения о запросе в SOAP, Bulk и REST API, включительно со сведениями о версии. См. сведения об определении события здесь. Организации с API имеют бесплатный доступ к файлам журнала событий "Общее использование API" с 1-дневной сохранностью данных. Если Отслеживание событий включено, у пользователя есть доступ к данным и всем другим типам файла журнала событий с 30-дневной сохранностью данных.

Можно также выполнить следующее для поиска запросов Bulk API или входов SOAP API:

• Поиск запросов Bulk API: При использовании Bulk API откройте страницу "Задания на загрузку массива данных" в меню "Настройка" и просмотрите сведения о каждом задании "Bulk V1". Данное прекращение поддержки повлияет на все задания, поле "Версия API" которых содержит значение "30.0" или ниже.

• Поиск входов SOAP API: При использовании операции SOAP login() перейдите в "Журнал входов" в настройке и просмотрите записи с типом API "SOAP Enterprise" или "SOAP Partner". Или, как вариант, можно отправить запрос LoginHistory sObject посредством SOQL. Данное прекращение поддержки повлияет на все вводы входа, поле "Версия API" которых содержит значение "30.0" или ниже.

Примечание: Партнеры могут использовать Журналы использования пакетов для получения важных данных об использовании нерекомендуемых API.

Как можно получить более подробную информацию?

Информацию о самых последних поддерживаемых версиях API см. на сайте разработчиков Salesforce.

Информация об API и исходящей службе сообщений:

• Основы Platform API (Trailhead)

• Введение в SOAP API (руководство разработчика)

• Понимание службы исходящих сообщений (руководство разработчика)

• Bulk API (руководство разработчика)

• Введение в REST API (руководство разработчика)

  • "REST" охватывает все API с URI-адресами конечной точки под /services/data/vXX.Y/ и /services/metadata/vXX.Y/, где XX.Y является версией API. Сюда входят "стандартные" Salesforce Platform REST API для работы с sObjects и записями, но также и следующие ресурсы:

    • Разработчик Metadata API

    • Tooling API

    • Chatter/Connect API

    • Вызов и вызов всех API

    • Search API

    • Limits API

    • API входа  (т.е. "Удостоверение")

• • • Просмотрите результаты запросов REST в GET /services/data/v30.0 или GET /services/metadata/v30.0 для определение ресурсов высокого уровня, затронутых при прекращении поддержки конечных точек v30.0 и ниже.

Если вы хотите получить дополнительную информацию о прекращении поддержки устаревших API, см. Важное обновление плана прекращения поддержки устаревших API.

Для получения объяснения версий API, направленных на администраторов, прослушайте подкаст здесь (ему уже несколько лет, но основная информация еще актуальна): Почему версии API важны с Крисом Гаррисоном.

Все равно мне нужна помощь. Что делать дальше?

• Просмотреть ресурсы ниже.

• Опубликовать сообщение в Trailblazer community.

• Создать обращение в службу поддержки Salesforce в справке Salesforce. Обязательно сообщите, что вы уже делали и на чем остановились, чтобы служба поддержки могла помочь наиболее эффективно. **Обратите внимание, что служба поддержки не может обновить устаревшие API в вашей организации.

Для просмотра текущих и прошлых продуктов с прекращенной поддержкой см. раздел Прекращение поддержки продуктов и функций Salesforce. Дополнительную информацию о принципах прекращения поддержки продуктов и функций Salesforce см. здесь.