Salesforce Platform API:n versioiden 21.0–30.0 käytöstä poistaminen

Alkuperäinen julkaisupäivä – 20. lokakuuta 2020

Päivitetty – 4. toukokuuta 2024
 

Mikä on SOAP-, REST- ja Bulk API ‑versioiden 21–30 tilanne?

• Tällä hetkellä: Nämä API-versiot poistetaan käytöstä (Summer ‘22 ‑julkaisun myötä) eikä niitä enää tueta. Voit käyttää niitä, mutta jos kohtaat ongelmia ja kirjaat tapauksen Salesforce-tukeen, sinun on ensin päivitettävä API-versio. Näille vanhoille API-versioille ei tarjota tukea tai virheiden korjauksia.

• Tulevaisuudessa: Summer ‘25 -julkaisu – Nämä API-versiot poistetaan käytöstä. Kyseisiä versioita käyttävissä sovelluksissa esiintyy häiriöitä, koska kutsut epäonnistuvat ja palauttavat virheen, jossa kerrotaan, ettei pyydettyä päätepistettä löydy eikä sovellusalusta voi käsitellä kutsuja. Virheet on kuvattu alla:

  • REST API palauttaa virheen 410: GONE.

  • SOAP API palauttaa virheen 500: UNSUPPORTED_API_VERSION.

  • Bulk API palauttaa virheen 400: InvalidVersion.

Huomaa: API-versiot 7.0–20.0 on jo poistettu käytöstä ja niiden käyttö estettiin Summer ’22 -julkaisussa.

Miksi poistamme nämä API-versiot käytöstä?
Keskitymme kehittämään uusimpia API-versioita parantaaksemme Salesforcen kokonaisvaltaista käyttökokemusta, kun laadit mukautettuja ominaisuuksia sovellusten avulla. Antaaksemme asioille hieman perspektiiviä, API-versio 30 oli peräisin Spring ’14 ‑julkaisustamme.

Mitä vaikutuksia näiden API-versioiden käytöstä poistamisella on?
Tämä käytöstä poistaminen vaikuttaa kaikkiin koodeihin, paketteihin, sovelluksiin ja integraatioihin, jotka suorittavat pyyntöjä SOAP API-, REST API- tai Bulk API -rajapinnan versioiden 21.0–30.0 kautta.

Huomaa: Käytöstä poistaminen ei vaikuta seuraaviin:

• APEX-luokkien, Apex-käynnistimien, Visualforce-sivujen, kulkujen ja Process Builder -prosessien API-versiot

• Käyttövalmis B2B Classic/Visualforce -tuote

• Hallitussa paketissa olevat versioidut metadatakomponentit

• Mukautetut Apex REST- ja SOAP-verkkopalvelut (Apex-luokan metodi voidaan tehdä kutsuttavaksi julkisena API-rajapintana mukautetun Apex-verkkopalvelun avulla. Lisätietoja Apex-verkkopalveluista löydät täältä: Apex-verkkopalvelut) 

Mitä minun täytyy tehdä?

1. Tunnista organisaatiosi mahdolliset komponentit/sovellukset, jotka käyttävät näitä vanhoja API-versioita.

2. Päivitä kyseiset komponentit/sovellukset. Sinun täytyy muokata sovelluksiasi tai päivittää ne toimimaan nykyisten tuettujen API-versioiden kanssa ennen Summer '25 -julkaisua. Salesforce suosittelee vahvasti siirtymään uusimpiin API-versioihin, sillä ne tarjoavat kehittyneempiä ominaisuuksia sekä parempaa tietoturvaa sekä suorituskykyä.

Tutustu joihin yleisimpiin vaikutuksiin ja niihin sovellettaviin toimenpiteisiin alla olevasta:

Mistä tiedän, käyttävätkö tai missä sovellukseni käyttävät näitä vanhoja API-versioita?

Kysy sovellusten kehittäjiltä, mitä API-versioita sovellukset käyttävät.

Lisäksi voit tarkastaa API-tapahtumat ilmaisilla API Total Usage EventLogFile -tapahtumilla, jotka sisältävät kaikki Salesforcesta tehdyt SOAP API-, REST API- ja Bulk API -toiminnot, jommallakummalla seuraavista tavoista.

1. Ensimmäinen tapa on käyttää uutta tapahtumalokien selainta, joka sisältyy Summer ‘24 -julkaisuun.  Sen avulla voit selata organisaatiosi API Total Usage -tapahtumalokien tiedostoja ja ladata ne CSV-tiedostoina tarkastellaksesi yksittäisiä API-tapahtumia.

Valitse Määritykset-valikosta Suojaus → Tapahtumien valvonta → Tapahtumalokien selain.  Tällä sivulla näet tapahtumalokitiedostot edelliseltä 24 tunnilta (tai 30 päivältä, jos olet ottanut Tapahtumien valvonta -ominaisuuden käyttöön).  Voit ladata yksittäisiä tapahtumalokitiedostoja CSV-tiedostoina tarkastaaksesi niiden sisältämät API-tapahtumat.

2. Toinen tapa on käyttää asiakassovellusta, kuten Salesforce CLI, SOQL-kyselyn suorittamiseksi EventLogFile-objektille, mikä tarjoaa tapahtumalokitiedostot edelliseltä 24 tunnilta (tai 30 päivältä, jos olet ottanut Tapahtumien valvonta -ominaisuuden käyttöön).

sf data query -q "SELECT Id, LogFile, EventType, CreatedDate FROM EventLogFile WHERE EventType IN ('ApiTotalUsage')" -o <käyttäjänimesi>

Suorita jokaiselle tulokselle REST API ‑pyyntö kyselytuloksessa oleviin päätepisteisiin noutaaksesi tapahtumalokitiedostossa olevat tapahtumalokitiedot*.

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

Liitä vastauksen tekstiosa sovellukseen, josta voit tarkastella lokitietoja helposti .CSV-tiedostona.

3. Tarkasta jokainen .CSV-tiedosto ja määritä, tehdäänkö pyyntöjä päätepisteisiin, joiden API-versio 30.0 tai sitä vanhempi.

Tarkasta kaikki API Total Usage -tapahtumat (ApiTotalUsage-tapahtumatyyppi), joiden API_VERSION on 30 tai sitä vanhempi**

4. Jos integraatiosi tai asiakassovelluksesi käyttävät versiota 30.0 tai sitä vanhempaa, noudata tapahtumalokitietojen avainkentissä annettuja vinkkejä, jotka auttavat tunnistamaan vanhojen API-kutsujen lähteen:

CLIENT_NAME, CONNECTED_APP_ID, ENTITY_NAME, USER_ID

Saat lisätietoja Tapahtumien valvonta -ominaisuudesta Trailhead-moduulista Event Monitoring.

*Jos tarvitset apua REST API -pyynnön suorittamiseen, katso Trailhead-moduuli Use REST API.

**”API Total Usage” -tapahtumatyyppi yhtenäistää relevantit pyyntötiedot kaikista SOAP API-, Bulk API- ja REST API -rajapinnoista, mukaan lukien versiotiedot. Katso tapahtumien määritelmien lisätiedot täältä. API-rajapintoja käyttävät organisaatiot voivat käyttää API Total Usage -tapahtumalokitiedostoja ilmaiseksi siten, että tietoja säilytetään yhden päivän ajan. Kun Tapahtumien valvonta -ominaisuus on käytössä, voit käyttää tätä ja kaikkia muita tapahtumalokitiedostojen tyyppejä siten, että tietoja säilytetään 30 päivän ajan.

Voit myös tunnistaa Bulk API ‑pyynnöt tai SOAP API ‑kirjautumiset seuraavalla tavalla:

• Bulk API ‑pyyntöjen etsiminen: Jos käytät Bulk API -rajapintaa, siirry Määritykset-valikon Massatietojen lataustyöt -sivulle ja tarkasta kunkin Bulk V1 -työn tiedot. Tämän API-rajapinnan version poistaminen käytöstä vaikuttaa kaikkiin töihin, joiden ”API-versio”-kentän arvo on 30.0 tai sitä vanhempi.

• SOAP API ‑kirjautumisten etsiminen: Jos käytät SOAP-rajapinnan login()-operaatiota, siirry Määritykset-valikon Kirjautumishistoria-sivulle ja tarkasta merkinnät, joiden API-tyyppi on ”SOAP Enterprise” tai ”SOAP Partner”. Voit myös kysellä sObjectia LoginHistory SOQL-rajapinnan kautta. Tämä käytöstä poistaminen vaikuttaa kaikkiin kirjautumismerkintöihin, joiden ”API-versio”-kentän on arvo on 30.0 tai sitä pienempi.

Huomaa: Kumppanit voivat hyödyntää pakettien käyttölokeja saadakseen havaintoja vanhojen API-rajapintojen käytöstään.

Mistä saan lisätietoja?

Katso uusimmat tuetut API-versiot Salesforce Developers -sivustolta.

Tietoja API-rajapinnoista ja lähtevästä viestinnästä:

• Platform API Basics (Trailhead)

• Introduction to SOAP API (Developer Guide)

• Understanding Outbound Messaging (Developer Guide)

• Bulk API (Developer Guide)

• Introduction to REST API (Developer Guide)

  • ”REST” kattaa kaikki API-rajapinnat, joiden päätepisteiden URL-osoitteet ovat poluissa /services/data/vXX.Y/ ja /services/metadata/vXX.Y/, joissa XX.Y on API-versio. Tämä sisältää ”vakiomuotoisen” Salesforce Platform REST API -rajapinnan, joka toimii sObjectien ja tietueiden kanssa, mutta myös seuraavat resurssit:

    • Metadata API Developer

    • Tooling API

    • Chatter/Connect API

    • Query- ja Query All API -rajapinnat

    • Search API

    • Limits API

    • Login API (eli ”Identity”)

• • • Katso päätepisteeseen GET /services/data/v30.0 tai GET /services/metadata/v30.0 lähetetyn REST-pyynnön tulokset nähdäksesi, mihin yleisen tason resursseihin version 30.0 ja sitä vanhempien päätepisteiden käytöstä poistaminen vaikuttaa.

Jos haluat lisätietoja tämän vanhan API-rajapinna version käytöstä poistamisesta, katso An Important Update to Our Legacy API Retirement Plan.

Jos haluat pääkäyttäjille tarkoitetun API-versioiden selityksen, kuuntele podcast täältä (se on muutaman vuoden vanha, mutta tärkeimmät tiedot ovat edelleen ajankohtaisia): Why API Versions Matter with Kris Harrison.

Tarvitsen edelleen apua. Mitä voin tehdä seuraavaksi?

• Tutustu yllä oleviin resursseihin.

• Julkaise viesti Trailblazer-yhteisöön.

• Lähetä asiakaspalvelulle tukipyyntö Salesforce-ohjeesta. Pidä mielessä, mitä olet jo yrittänyt ja mihin kohtaan jäit jumiin, jotta asiakastuki voi auttaa sinua mahdollisimman tehokkaasti. **Huomaa, että asiakastuki ei voi päivittää organisaatiossasi käytettyjä vanhoja API-rajapintoja.

Näet kaikki nykyiset ja menneet tuotteiden käytöstä poistamiset Salesforce-ominaisuuksien tuen lopettaminen -artikkelista. Jos haluat lukea Salesforcen lähestymistavasta tuotteiden ja ominaisuuksien käytöstä poistamiseen, katso Tuotteiden ja ominaisuuksien tuen lopettamisen periaatteet.