📘 Yleiset API-resurssit
Tervetuloa Esadaxin API-referenssiin. Täältä löydät kaikki olennaiset tiedot, joita tarvitset API:mme kanssa vuorovaikutuksessa, mukaan lukien miten todentaa, ymmärtää vastausten tilat ja ratkaista vahvistusvirheet.
Autentikointi
Kaikki API-pyynnöt on todennettava API-tunnuksen avulla. Tämä tehdään lisäämällä Authorization-otsikko HTTP-pyyntöösi.
✅ Otsikon muoto
Authorization: Bearer XXX
Korvaa XXX varsinaisella API-tunnuksellasi.
Tietoja API-tunnuksista
- API-tunnukset luodaan käyttäjätiliä kohden.
- Jokaisella tunnisteella voi olla mukautetut käyttöoikeudet, joilla rajoitetaan pääsyä tilisi tietyille alueille.
- Tämä auttaa pitämään integroinnin suojattuna myöntämällä vain tarvittavan käyttöoikeuden.
➡️ Lue lisää API-tunnusten hallinnasta
Ohjelmointirajapinnan vastaukset
Esadax käyttää RESTful-periaatteita ja noudattaa standardinmukaisia HTTP-vastauskäytäntöjä. Jokainen API:n vastaus sisältää asiaankuuluvan HTTP-tilakoodin, joka ilmaisee pyyntösi onnistumisen tai epäonnistumisen.
📊 HTTP-tilakoodit
| Koodi | Nimi | Kuvaus |
|---|---|---|
| 200 kappaletta | Okei. | Pyyntö hyväksyttiin onnistuneesti. |
| 201 artikla | Luotu | Resurssi luotiin onnistuneesti. |
| 202 artikla | Hyväksytty | Pyyntö hyväksyttiin ja käsittely jatkuu taustalla. |
| 204 sivua | Ei ole sisältöä | Pyyntö hyväksyttiin, mutta palautettavaa sisältöä ei ole. |
| 400 | Huono pyyntö | Pyynnössäsi tapahtui virhe. Tarkista päätelaitteen vaatimukset ja yritä uudelleen. |
| 401 artikla | Luvaton | Virheellinen API-tunnus. Lue lisää. |
| 403 sivua | Kielletty | Toiminto ei ole sallittu tälle tunnukselle tai tilille. Tarkista tunnuksen käyttöoikeudet. |
| 404 Ei löydy | Sivua ei löytynyt | Pyydettyä resurssia ei ole olemassa. |
| 405 sivua. | Menetelmä ei sallittu | Käytettyä HTTP-menetelmää ei tueta tässä päätepisteessä. |
| 408 sivua. | Pyynnön aikakatkaisu | Meidän puolelta tuli aikalisä. Ota yhteyttä tukeen. |
| 421 artikla | Palvelu ei ole käytettävissä | Sivustomme on huoltotauolla. Yritä myöhemmin uudelleen. |
| 422 sivua | Käsittelemätön kokonaisuus | Validointivirhe pyynnössäsi. Tarkista ja yritä uudelleen. Lue lisää |
| 429 sivua. | Liikaa pyyntöjä | Nopeusrajoitus ylitetty. Lue lisää nopeusrajoituksista |
| 500 kappaletta | Sisäinen palvelinvirhe | Odottamaton palvelinvirhe. Ota yhteyttä tukeen. |
| 502 sivua | Virheellinen yhdyskäytävä | Väliaikainen järjestelmäongelma. Ota yhteyttä tukeen. |
| 503 artikla | Palvelu ei ole käytettävissä | Järjestelmä ei ole tällä hetkellä käytettävissä. Ota yhteyttä tukeen. |
| 504 sivua | Yhdyskäytävän aikakatkaisu | Järjestelmässämme tapahtui aikakatkaisu. Ota yhteyttä tukeen. |
🔗 Lisätietoja HTTP-tilakoodeista on osoitteessa Mozilla Developer Network.
Validation Errors (Tarkistusvirheet)
Vahvistusvirheet (HTTP 422) ilmenevät, kun pyyntösi hyötykuorma ei täytä tietyn päätepisteen vaatimuksia. Tämä voi johtua:
- Vaaditut kentät puuttuvat
- Virheelliset tietomuodot
- Virheelliset parametrit
Tarkista aina uudelleen API-päätepistedokumentaatio varmistaaksesi, että pyyntösi runko vastaa odotettua muotoa.
