Käytä tätä opasta, kun pyyntö Pleon ohjelmointirajapintaan epäonnistuu. Etsi virheesi alta ja seuraa asianmukaisia tarkistuksia.
Päätepisteiden lisätietoja, vaadittavia laajuuksia ja pyyntöesimerkkejä löydät Pleon kehittäjädokumentaatiosta.
Ennen vianmääritystä
| Tarkista | Vahvista |
|---|---|
| API | Käytätkö uutta API:a vai Legacy API:a? |
| Perus-URL ja ympäristö | Vastaako isäntä ohjelmarajapintaa ja haluttua ympäristöä (staging- vai production-ympäristö)? |
| Todennus | Mitä todennusmenetelmää ja kirjautumistietotyyppiä käytät? |
| Kirjautumistietojen vastaavuus | Vastaavatko kirjautumistiedot ohjelmarajapintaa ja ympäristöä? Älä koskaan käytä staging-kirjautumistietoja production-ympäristössä tai production-ympäristön kirjautumistietoja staging-ympäristössä. |
API-virheet
400 / 422 — Invalid request
Pyyntö on virheellinen tai se ei läpäise validointia.
- Lue vastauksen sisältö tunnistaaksesi puuttuvat kentät tai virheelliset arvot.
- Vertaa pyyntöäsi päätepisteiden dokumentaatioon. Tarkista pakolliset kentät, pyynnön rakenne, päivämäärämuodot ja sallitut arvot.
- Korjaa havaittu ongelma ja yritä pyyntöä uudelleen.
401 — Todennus epäonnistui
Pyyntöä ei voitu todentaa.
- Varmista, että kirjautumistiedot vastaavat ohjelmarajapintaa ja ympäristöä. Tarkista pyynnön isäntä kehittäjädokumentaatiosta. Älä sekoita uuden ohjelmarajapinnan ja Legacy API:n kirjautumistietoja tai staging- ja production-ympäristöjen kirjautumistietoja.
- Tarkista todennuksen otsikko (Authorization). Uudet API-avaimet käyttävät Basic-todennusta, jossa avain on käyttäjänimi ja salasana on tyhjä. OAuth-käyttötokenit käyttävät Bearer-todennusta. Noudata Legacy API -dokumentaatiota vanhojen tokenien osalta. Poista kirjautumistiedoista ylimääräiset välilyönnit tai rivinvaihdot.
- Tarkista kirjautumistietojen tila. Vahvista, että ne eivät ole vanhentuneet tai peruutettu. OAuth:n osalta käytä käyttötokenia, ei päivitystokenia, ja varmista, että tokenin päivitysprosessi toimii.
403 — Käyttöoikeudet tai yrityksen käyttöoikeus
Pyyntö todennettiin, mutta käyttöoikeus evättiin.
- Tarkista laajuudet. Vertaa kirjautumistietojesi määritettyjä laajuuksia päätepisteen vaatimiin laajuuksiin. Jos et pysty tarkastelemaan niitä, pyydä kirjautumistietoja hallinnoivaa henkilöä vahvistamaan ne.
- Tarkista yritys ja ympäristö. Kirjautumistietojen on vastattava yritystä tai yksikköä, jonka tietoja pyydät, sekä ympäristöä, johon olet yhteydessä.
- Tarkista päätepisteen saatavuus. Varmista kehittäjädokumentaatiosta, että päätepiste tukee todennusmenetelmääsi ja käyttötapaustasi.
Jos nämä täsmäävät mutta käyttöoikeus evätään edelleen, ota yhteyttä tukeen, jotta voit vahvistaa yrityksen ohjelmointirajapinnan käytön. Mainitse, toimiiko sama kirjautumistieto muissa päätepisteissä.
404 — Päätepistettä tai resurssia ei löytynyt
Pyydettyä päätepistettä tai resurssia ei löytynyt.
- Vertaa perus-URL-osoitetta, API-versiota ja päätepisteen polkua kehittäjädokumentaatioon.
- Vahvista, että resurssin ID vastaa pyytämääsi resurssia.
- Tarkista, että resurssi kuuluu kirjautumistietoon liitettyyn yritykseen ja ympäristöön. Älä sekoita staging- ja production-ID:tä.
Resurssi voi palauttaa virheen 404, vaikka se olisi olemassa Pleossa, jos se kuuluu eri yritykseen tai ympäristöön.
409 — Ristiriitainen toiminto
Pyyntö on ristiriidassa olemassa olevan toiminnon tai tilan kanssa.
- Lue virheen vastaus ja tarkista, onko sama toiminto jo lähetetty. Tarkasta edellinen vastaus tai siitä syntynyt toiminto ennen kuin lähetät sen uudelleen.
- Noudata päätepisteen ristiriidan ja idempotenssin ohjeita kehittäjädokumentaatiossa.
429 — Liian monta pyyntöä
Integraatiosi lähettää pyyntöjä liian usein.
- Tarkista vastausotsikot uudelleenyritys- tai määrärajoitusohjeita varten.
- Vähennä pyyntöjen tiheyttä ja vältä välittömiä uudelleenyrityksiä tiukassa silmukassa.
- Käytä eksponentiaalista peruutusta päätepisteen uudelleenyritysohjeita noudattaen.
Jos ongelma jatkuu pienellä pyyntömäärällä, ota yhteyttä tukeen ja ilmoita pyyntötiheytesi ja uudelleenyritystoimintasi.
5xx — Palvelinpuolen virhe
Palvelinpuolella tapahtui virhe. Kerää virheen vastaus ja pyyntötiedot kohdasta ”Tarvitsetko vielä apua?” ja ota yhteyttä tukeen. Mainitse, tapahtuiko virhe kerran vai toistuuko se.
Webhook-toimituksen ongelmat
Jos webhook-tapahtumat eivät saavu integraatioosi tai niitä ei käsitellä:
- Tarkista saavutettavuus. Vastaanottavan päätepisteesi on oltava julkisesti saavutettavissa HTTPS:n kautta, eikä se saa estää Pleosta tulevia pyyntöjä.
- Tarkista toimituslokit. Etsi toimitusyritys, vastauksen tila ja vastausaika. Palauta 2xx-vastaus nopeasti webhook-dokumentaation vaatimusten mukaisesti.
- Tarkista allekirjoituksen vahvistus. Käytä pyyntörunkoa webhook-dokumentaation edellyttämässä muodossa, mukaan lukien raakarunkoa siellä, missä se on määritelty.
- Käsittele kaksoistoimitukset turvallisesti. Poista kaksoiskappaleet dokumentaatiossa määritellyn tapahtuma- tai webhook-tunnisteen avulla.
Tarkista muutoksen jälkeen seuraava toimitus. Jos se edelleen epäonnistuu, ilmoita tilauksen ID, tapahtuma- tai webhook-ID, toimituksen aikaleima, päätepisteen vastauksen tila ja anonymisoidut lokit, kun otat yhteyttä tukeen.
Tarvitsetko vielä apua?
Jos tarkastukset eivät ratkaise ongelmaa, ota yhteyttä Pleo-tukeen seuraavien tietojen kanssa:
- Pyynnön konteksti: ohjelmarajapinta, isäntä, ympäristö, päätepiste, HTTP-metodi sekä yrityksen tai organisaation ID.
- Ajoitus:aikaleima ja aikavyöhyke sekä pyyntö- tai korrelaatio-ID, jos ne ovat saatavilla.
- Virheen lisätiedot: vastauksen tila ja anonymisoitu vastausrunko.
- Pyyntötiedot: anonymisoidut otsikot ja hyötykuorma; kirjautumistietojen tyyppi ja API-avaimen ID tarvittaessa, mutta ei koskaan salausavainta.
- Mitä kokeilit: toistamisen vaiheet, odotettu ja todellinen toiminta sekä jo suoritetut tarkistukset.
Lisää Webhook-ongelmien osalta myös yllä mainitut toimituksen lisätiedot.
Auttoiko tämä artikkeli?
Loistavaa!
Kiitos palautteestasi
Pahoittelut ettemme voineet auttaa
Kiitos palautteestasi
Palaute lähetetty
Kiitos palautteesta. Yritämme korjata artikkelin