Crossref
https://api.crossref.org/works?rows=1
DokumentaatioPerusteelliset käytännön oppaat
Määritä kysely, sivutus, virheet ja raakavastaus ennen tiedon muuntamista.
Päivitetty :

Tekoälyllä luotu kuvitus
API vastaa kyselyyn tietyllä rakenteella ja hetkellä. Se ei osoita koko tietokannan kysymistä tai muuttumattomuutta kutsujen välillä. Erota keruun kirjaus analyysistä.
Lue viralliset ohjeet: versio, rajaus, ehdot, tunnistautuminen ja rajat. Koko tietokantaa varten etsi virallinen vienti.
Kirjaa endpoint, menetelmä, parametrit, suodatus ja järjestys. Suosi tunnisteita äläkä julkaise avaimia tai tokeneita.
Säilytä HTTP-tila, aika, muoto ja virheet. Tarkista kentät ja yksiköt; HTTP 200 voi sisältää tyhjän vastauksen tai toimintavirheen.
Tutki kokonaismäärä, sivut ja kursorit. Laske rivit sekä yksilölliset tunnisteet, kirjaa toistot ja pysäytysehto. Tietokanta voi muuttua keruun aikana.
Pidä raakavastaus ja tiiviste; dokumentoi siivous ja muunnokset. Älä julkaise henkilötietoja tai salaisuuksia avoimessa lokissa.
Noudata uusintapyyntöjen ohjeita 429-tilassa tai katkossa. Uusi poiminta on uusi havainto; vertaa myös rakennetta ja rajausta.
Osoitteet näyttävät syntaksin. Tarkista saatavuus, tunnistautuminen ja ehdot dokumentaatiosta.
Tietojen lukemisen työpaja
DEMO-HTTP-vaihdot ovat kuvitteellisia. Osio ei ota yhteyttä palvelimeen eikä uusi pyyntöjä.
Kuvitteellisia tietoja ja merkintöjä oppimista varten: tulokset eivät ole peräisin suorista palvelukyselyistä.
Skenaarion asiakas säilyttää area=A-esityksen ETag-tunnisteineen. Kuvitteellinen käytäntö rajaa yritykset kahteen eikä takaa palvelun saatavuutta.
Avaa jokainen väite ja vertaa sen tulkintaa. Lisätarkistuksia voi silti tarvita.
Ei. Skenaario käyttää saman valinnan kopiota. Puuttuvasta rungosta ei tule tyhjää taulukkoa.
Ei. Se muuttaa havaintojen rajauksen huomaamatta. Parametrit kuuluvat kirjaukseen.
Kyllä. Lokista on tunnistettava käytetyt tiedot ja yritykset, jotka eivät tuottaneet uutta poimintaa.
Valinta: GET /demo?area=A Kopio: runko säilytetty; ETag="demo-v1" Ehto: If-None-Match="demo-v1" Vastaus: 304; viite A-kopioon Toinen yritys: 429; Retry-After=15 sekuntia DEMO-käytäntö: enintään kaksi yritystä, sitten pysähdys Uudelleenjulkaisuoikeudet: tarkista erikseen
Kahden yrityksen raja kuuluu esimerkkiin, ei RFC:ihin. Älä keksi sisältöä ilman käyttökelpoista kopiota; valmistele uusi nouto palvelun käytännön mukaan.
Tarkista kokonaismäärä ja seuraava kursori ennen kattavan luvun julkaisemista.
Erota null, puuttuva kenttä, tyhjä lista ja nolla; ne vaikuttavat keskiarvoon.
Eurostat kuvaa uusimpien versioiden tietokannan. Säilytä päivätty poiminta vanhojen laskujen toistamiseksi.
Harjoitus ja ratkaisu
Kuvitteellinen esimerkki: arvot ja asiakirjat opettavat menetelmää eivätkä kuvaa todellista organisaatiota.
Kuvitteellisen API:n sopimus edellyttää success=true-arvoa ennen käsittelyä. Tarkista HTTP-vastaus, sovelluksen tila ja tulosten olemassaolo erikseen.
Jos taulukko ylittää näytön, vieritä vaakasuunnassa; nuolinäppäimet toimivat alueen ollessa kohdistettuna.
| Kohde | Havaittu tieto |
|---|---|
| HTTP-tila | 200 |
| Sovelluksen tunnistin | success=false |
| Vastaanotettu viesti | Viesti: kiintiö täynnä |
| Tulostaulukko | Taulukkoa ei annettu |
Siirto vastasi, mutta keruu epäonnistui sopimuksen mukaan. Nollamäärää ei ole osoitettu. Merkitse epäonnistuminen ja noudata uusintaohjetta; älä keksi tyhjää taulukkoa laskennan jatkamiseksi.
Jos onnistunut vastaus sisältää aidosti tyhjän taulukon, nolla voidaan osoittaa ilmoitetulle haulle ja rajaukselle. Toista testi success=true-arvolla mutta kesken katkenneella JSON-rungolla: tila ja lippu eivät vieläkään riitä. Hylkää vajaa erä, säilytä jatkamiskohta ja varmista, etteivät osittaiset arvot korvaa viimeistä vahvistettua poimintaa.
Säilytä salaisuuksista siivottu haku, tila, virhe, sopimus ja uusintatila.
Dokumentaatioviite : IETF — RFC 9110, 200 OK · Luettu
DOKUMENTOIDUT TIEDOT
Truthy on tekninen näkymä kohde–ominaisuus-parille: ensisijaiset syrjäyttävät normaalit; muutoin normaalit valitaan. Se ei äänestä lähteistä eikä valitse uusinta päivää.
| Viite | Arvo tai muoto | Mitä se yksilöi |
|---|---|---|
| PreferredRank | Preferred | Kaikki parin ensisijaiset valitaan. Ensisijaisuus ei takaa yhtä arvoa. |
| NormalRank | Normal | Normaalit valitaan vain, jos parilla ei ole ensisijaisia. Useat normaalit voivat olla perusteltuja. |
| DeprecatedRank | Deprecated | Vanhentuneet väitteet jäävät truthyn ulkopuolelle, mutta täydet väitteet voivat säilyttää virheet ja hylätyt arvot. |
| wdt: | Best non-deprecated rank | Suora polku käyttää parhaita ei-vanhentuneita asemia ilman tarkenteita. Ajantasaisuutta, kattavuutta tai tukea ei taata. |
| wikibase:BestRank | Full statement selection | Tyyppi valitsee täydet parhaan aseman väitesolmut säilyttäen tarkenteet ja lähteet. |
| Scope | Entity + property | Sääntö on kohde- ja ominaisuuskohtainen. Väestön ensisijaisuus ei valitse perustamisaikaa tai nimeä. |
Jos kaikki on hylätty, älä oleta paluuta niihin. Erimielisyys ja historia vaativat täydet väitteet asemineen. Suoran kyselyn puute voi johtua suodatuksesta.
Ei. Asema ja aikamääre ovat eri mekanismeja. Tarkista ajankohta ja asemakäytäntö; ensisijaisia väitteitä voi olla useita.
Dokumentaatio tarkistettu .
DOKUMENTOIDUT TIEDOT
JSON-vastaus sisältää muutakin kuin arvon. Todellinen ote koskee Suomen väestötiheyttä vuonna 2023. Otsake ilmoittaa WDI-päivityksen päiväksi 8.10.2026; tämä poiminta haettiin 23.10. Kolme päivämäärää vastaavat eri kysymyksiin.
| Viite | Arvo tai muoto | Mitä se yksilöi |
|---|---|---|
| date | 2023 | Havaintovuosi. Se ei muutu vuodeksi 2026, vaikka kysely tehtiin vuonna 2026. |
| lastupdated | 2026-10-08 | Lähteen otsakkeen ilmoittama päivityspäivä. Se ei yksin todista juuri tämän arvon tarkistamista. |
| extracted | 2026-10-23 | Paikallisen poiminnan muodostamispäivä; se ei korvaa havaintojaksoa tai lähteen päivämäärää. |
| unit | "" | unit-kenttä on tyhjä. EN.POP.DNST määrittelee silti yksiköksi henkilöä/km² maata: tyhjä kenttä ei tarkoita yksiköttömyyttä. |
| decimal / value | 0 / 18.3705454665088 | decimal on nolla, vaikka value sisältää desimaaleja. Säilytä saatu arvo äläkä tulkitse kenttää virhemarginaaliksi. |
| pages / total | 1 / 4 | Neljä havaintoa mahtuu yhdelle vastaussivulle. Toinen kysely voi olla sivutettu: tarkista pages ja total ennen kuin pidät keruuta täydellisenä. |
https://api.worldbank.org/v2/country/FRA;DEU;ESP;FIN/indicator/EN.POP.DNST?date=2023&format=json&per_page=100
[
{
"page": 1,
"pages": 1,
"per_page": 100,
"total": 4,
"sourceid": "2",
"lastupdated": "2026-10-08"
},
[
{
"indicator": {
"id": "EN.POP.DNST",
"value": "Population density (people per sq. km of land area)"
},
"country": {
"id": "FI",
"value": "Finland"
},
"countryiso3code": "FIN",
"date": "2023",
"value": 18.3705454665088,
"unit": "",
"obs_status": "",
"decimal": 0
}
]
]Tämä on päivätty API-poiminta, joka ei päivity automaattisesti sivua ladattaessa. Sama maatunnus ei todista sarjojen samaa alueellista kattavuutta. Säilytä koko kysely, määritelmät ja puuttuvat arvot analyysin toistamista varten; älä muuta null-arvoa nollaksi.
Dokumentaatio tarkistettu .
DOKUMENTOIDUT TIEDOT
Parametriluettelo on järjestetty nimi–arvo-parien jono. Sama nimi voi toistua. Työkalu soveltaa application/x-www-form-urlencoded-muotoa URLSearchParamsilla kahteen yksiriviseen arvoon ja jäsentää tuloksen; lomaketta ei lähetetä.
| Viite | Arvo tai muoto | Mitä se yksilöi |
|---|---|---|
| U+0020 | + | U+0020-välilyönti sarjallistuu tässä muodossa plusmerkiksi. Sääntö ei koske yleisesti URL-osoitteen kaikkia osia. |
| + | %2B | Arvoon kuuluva plusmerkki muuttuu muotoon %2B. Suoraan jo koodattuun merkkijonoon liitetyn C++-arvon plusmerkit tulkittaisiin välilyönneiksi. |
| & | %26 | Arvon sisäinen & muuttuu muotoon %26 eikä aloita uutta parametria. |
| = | %3D | Arvon sisäinen = muuttuu muotoon %3D; nimen ja arvon rakenteellinen erotin säilyy =-merkkinä. |
| été | %C3%A9t%C3%A9 | Muut kuin ASCII-merkit koodataan UTF-8:sta. Prosenttijonot esittävät tavuja, eivät näkyvien kirjainten määrää. |
| append / get / getAll / set | ordered pairs | append säilyttää uuden esiintymän. get palauttaa ensimmäisen arvon ja getAll kaikki arvot järjestyksessä. set korvaa ensimmäisen ja poistaa saman nimen muut esiintymät. |
Kaksi esimerkkiarvoa lasketaan tällä sivulla.
Kaksi paria säilytetty järjestyksessä.
tag=C%2B%2B+%26+IA&tag=%C3%A9t%C3%A9
["C++ & IA","été"]
"C++ & IA"
Koodaus ei ole salausta eikä HTML:n puhdistusta. Esimerkki ei mallinna lomakekenttien valintaa, multipart-tiedostoja tai lomakkeen rivinvaihtojen normalisointia. Palvelimen on määriteltävä toistuvien parametrien käsittely; liian varhainen muunnos olioksi voi kadottaa arvoja.
Dokumentaatio tarkistettu .
Ei. Tarkista sisältö, suodatus, kokonaismäärä ja sivutus.
Ei. Valitse hyödyllinen rajaus ja dokumentoi se.
Se vertaa säilytettyjä tavuja. Menetelmä ja laatu vaativat omat tarkistuksensa.
Pidä viimeinen vaihe vahvistettu, asetukset ja viittaukset jatko. Palautus on tarkistettava kaksoistuminen ja mahdolliset muutokset tietoja sen sijaan, että oletetaan yksinkertainen lisääminen vastauksia.
DOKUMENTOIDUT TIEDOT
Kaksi muokkaajaa voi lukea saman version ja lähettää eri korjaukset. Esiehto antaa palvelimelle keinon hylätä vanhaan esitykseen perustuva kirjoitus. Tapaukset ovat kuvitteellisia: v1 ja v2 ovat opetusmerkintöjä, eivät havaintoja palvelusta.
Luku → samanaikainen muutos → kirjoituksen hylkäys: kuvitteellinen esimerkki.
| Viite | Arvo tai muoto | Mitä se yksilöi |
|---|---|---|
| PUT · If-Match: "v1" | ETag: "v2" → 412 | Asiakirja muuttui lukemisen jälkeen. Tämän PUT-pyynnön vahva vertailu epäonnistuu: nykyistä versiota ei pidä korvata. Lue se uudelleen ja tarkista erot. |
| PUT · If-Match: "v2" | ETag: "v2" → ✓ | Vahvat tunnisteet täsmäävät, joten tämä esiehto sallii käsittelyn jatkamisen. Se ei takaa tilakoodia 200 tai muiden tarkistusten onnistumista. |
| PUT · If-Match: W/"v2" | ETag: "v2" → 412 | Tunnisteen teksti täsmää, mutta toinen on heikko. If-Match edellyttää vahvaa vertailua ja epäonnistuu. W/-etuliitteen poistaminen ei luo vahvaa validaattoria. |
| PUT · If-None-Match: * | Olemassa → 412 / Puuttuu → ✓ | Kirjoituksessa tähti edellyttää, ettei nykyistä esitystä ole. Jos esitys on olemassa, ehto on epätosi; muuten käsittely voi jatkua. |
| GET · If-None-Match: W/"v2" | ETag: "v2" → 304 | GET- ja HEAD-pyynnöissä If-None-Match käyttää heikkoa vertailua. Täsmääminen johtaa vastaukseen 304: käytetään säilytettyä kopiota ilman uutta runkoa. |
| 428 | Precondition Required | Palvelin vaatii ehdollisen pyynnön. Puuttuva esiehto eroaa koodista 412, jossa annettu ehto on epätosi. Vastausta 428 ei saa tallentaa välimuistiin. |
Muuta menetelmää, tilaa ja ehtoa. Anna tunniste lainausmerkeissä, pilkuin erotettu lista tai pelkkä *. Tarkistus tapahtuu selaimessasi. Kun ehtona on * tai esitys puuttuu, nykyistä ETag-arvoa ei käytetä.
412: ehto ei täyty. Pyydettyä toimintoa ei saa tehdä.
Paikallinen opetussimulaatio: API-pyyntöjä ei lähetetä eikä tietoja tallenneta.
Ehto täyttyy: jatka muita tarkistuksia ja normaalia käsittelyä. Onnistumisen tilakoodia ei päätellä.412: ehto ei täyty. Pyydettyä toimintoa ei saa tehdä.304: ehto ei täyty GET/HEAD-pyynnölle. Käytä säilytettyä kopiota.Virheellinen syntaksi: käytä HTTP-tunnisteita lainausmerkeissä tai pelkkää *. Jos esitys on olemassa, nykyisen ETag-arvon on oltava yksi tunniste.Harjoitus arvioi yhden esiehdon ennen toimintoa. Pyyntö oletetaan muuten hyväksyttäväksi, ja jo onnistuneesti suoritetun toiminnon erityistapaus on rajattu pois. Tunnistautuminen, oikeudet, asiakirjan tarkistus ja toimintalogiikka on silti tarkistettava. API:n on tarkistettava ehto ja tehtävä muutos atomisesti, jotta päivityksiä ei katoa.
Dokumentaatio tarkistettu .
SYVENTÄVÄ LUKEMINEN / KÄYTÄNTÖ
API tarjoaa hyödyllisiä tietoja, mutta tulos riippuu asetuksista ja sivuista. Keräyksen on säilytettävä täydellinen pyyntö ja edellytykset vastauksen ymmärtämiseksi.
Päivitetty .
Valitse URL, asetukset, tila, muoto ja sivu. Tarkista suodattimet, volyymirajat ja palautetut virheet ilman salaisuuksia päiväkirjoissa.
Menestyksekäs vastaus voi sisältää vain yhden tuloksen sivun. Toista kysely myöhemmin voi antaa toisen tilan, jos tiedot ovat muuttuneet.
Keräyslehti yhdistää kyselyn, päivämäärän, säilytetyn vastauksen, kattavuuden ja rajan. Se kertoo, miten kierrätys voidaan tarkistaa tai tarkistaa.