Rajapintadokumentaatio Redfox sanakirja API
Autentikointi
API:n käyttö vaatii autentikoinnin.
POST https://api.redfoxsanakirja.fi/redfox-api/api/authenticate
Content body (application/x-www-form-urlencoded)
username=KäyttäjätunnusTähän&password=SalasanaTähän Vastauksessa tulee mukana Authorization header, jonka sisältönä on Bearer token jota tarvitaan autentikoimaan muut kutsut. Esim.
Bearer abcef1235fjgjh234
Tämä token täytyy antaa muiden kutsujan mukana headerissa, Authorization avaimella.
Sanastohaku
Yksittäinen sana
Kutsu
GET https://api.redfoxsanakirja.fi/redfox-api/api/dictionary/search/fin/eng/koira
POST https://api.redfoxsanakirja.fi/redfox-api/api/dictionary/search
Content body (application/json)
{
"sourceLanguage": "fin",
"targetLanguage": "eng",
"text": "koira"
} Vastaus
{
"query": {
"searchText": "koira",
"sourceLanguage": "fin",
"destinationLanguage": "eng",
"type": "BASIC"
},
"suggestion": [
"koiras",
"koura",
"Kiira",
"koirat",
"koiran",
"koiraa",
"koiria",
"koisa",
"koria",
"kopra"
],
"redfoxSecondaryTermbankTranslations": {
"entryGroups": [
{
"gategory": "null",
"entries": [
{
"text": "[[dog]]",
"context": "Yleiskieli",
"entryLanguage": "eng",
"source": "RedFox Secondary Termbank"
},
{
"text": "[[hound]]",
"context": "Yleiskieli",
"entryLanguage": "eng",
"source": "RedFox Secondary Termbank"
},
{
"text": "[[dog]]",
"context": "Yleiskieli / koiraeläimet (Finto)",
"entryLanguage": "eng",
"source": "RedFox Secondary Termbank"
},
{
"text": "[[Dog]]",
"context": "HeiNER_56",
"entryLanguage": "eng",
"source": "RedFox Secondary Termbank"
},
{
"text": "[[dog]]",
"context": "OmegaWiki",
"entryLanguage": "eng",
"source": "RedFox Secondary Termbank"
}
]
}
],
"empty": false
},
"redfoxThirdTermbankTranslations": {
"empty": true
},
"customerTermbankTranslations": {
"empty": true
},
"translations": {
"entryGroups": [
{
"gategory": "NOUN",
"entries": [
{
"text": "[[dog]]",
"context": "Hund",
"entryLanguage": "deu",
"source": "Wiktionary"
}
]
}
],
"empty": false
},
"additionalTranslations": {
"empty": true
},
"iateTranslations": {
"entryGroups": [
{
"gategory": "null",
"entries": [
{
"text": "[[dog]]",
"contextCodes": [
"52"
],
"entryLanguage": "eng",
"source": "IATE"
}
]
}
],
"empty": false
},
"synonyms": {
"entryGroups": [
{
"gategory": "NOUN",
"entries": [
{
"text": "peni",
"context": "archaic",
"entryLanguage": "eng",
"source": "Wiktionary"
},
{
"text": "hauva",
"context": "baby talk",
"entryLanguage": "eng",
"source": "Wiktionary"
},
{
"text": "hurtta",
"context": "old|poetic",
"entryLanguage": "eng",
"source": "Wiktionary"
},
{
"text": "rakki",
"context": "derogatory",
"entryLanguage": "eng",
"source": "Wiktionary"
},
{
"text": "piski",
"context": "derogatory",
"entryLanguage": "eng",
"source": "Wiktionary"
},
{
"text": "murre",
"context": "derogatory",
"entryLanguage": "eng",
"source": "Wiktionary"
},
{
"text": "tiisti",
"context": "derogatory",
"entryLanguage": "eng",
"source": "Wiktionary"
},
{
"text": "hunttu",
"context": "dialectal|humorous",
"entryLanguage": "eng",
"source": "Wiktionary"
},
{
"text": "koiranuinti",
"entryLanguage": "eng",
"source": "Wiktionary"
},
{
"text": "sotilaspoliisi",
"entryLanguage": "eng",
"source": "Wiktionary"
},
{
"text": "[[hauva]]",
"context": "lastenkieltä",
"entryLanguage": "fin",
"source": "Wiktionary"
},
{
"text": "[[halli]]",
"context": "lastenkieltä",
"entryLanguage": "fin",
"source": "Wiktionary"
},
{
"text": "[[moppe]]",
"context": "lastenkieltä",
"entryLanguage": "fin",
"source": "Wiktionary"
},
{
"text": "[[piski]]",
"context": "humoristinen",
"entryLanguage": "fin",
"source": "Wiktionary"
},
{
"text": "[[rakki]]",
"context": "halventava",
"entryLanguage": "fin",
"source": "Wiktionary"
},
{
"text": "[[hurtta]]",
"context": "vanhahtava, runollinen; leikkimielisen halventava",
"entryLanguage": "fin",
"source": "Wiktionary"
},
{
"text": "[[peni]]",
"context": "vanhahtava",
"entryLanguage": "fin",
"source": "Wiktionary"
}
]
}
],
"empty": false
},
"redfoxSecondaryTermbankDefinitions": {
"empty": true
},
"redfoxThirdTermbankDefinitions": {
"empty": true
},
"customerTermbankDefinitions": {
"empty": true
},
"definitions": {
"entryGroups": [
{
"gategory": "NOUN",
"entries": [
{
"text": "''Canidae-''heimon [[susi|suden]] sukuinen [[kotieläin|kotieläimeksi]] kesyyntynyt [[eläin]] ([[species:Canis lupus familiaris|''Canis lupus familiaris'']])",
"entryLanguage": "fin",
"source": "Wiktionary"
}
]
}
],
"empty": false
},
"usageExamples": {
"entryGroups": [
{
"gategory": "NOUN",
"entries": [
{
"text": "'''''Koiraa''' pidetään lähinnä lemmikkieläimenä tai harrastuksen vuoksi esimerkiksi metsästys- tai näyttelykoirana, mutta myös hyötykäytössä esimerkiksi poliisin tai tullin huumekoirana taikka näkövammaisen opaskoirana.''",
"entryLanguage": "fin",
"source": "Wiktionary"
}
]
}
],
"empty": false
},
"definitionsInDestLanguage": {
"entryGroups": [
{
"gategory": "NOUN",
"entries": [
{
"text": "[[dog]]",
"entryLanguage": "eng",
"source": "Wiktionary"
},
{
"text": "[[dog paddle]] (swimming stroke)",
"entryLanguage": "eng",
"source": "Wiktionary"
},
{
"text": "(military slang[[Category:Finnish military slang]]) [[military police]]",
"entryLanguage": "eng",
"source": "Wiktionary"
}
]
},
{
"gategory": "PROPER_NOUN",
"entries": [
{
"text": "[[Dog#English|Dog]] (the eleventh animal in the 12-year cycle in Chinese zodiac)",
"entryLanguage": "eng",
"source": "Wiktionary"
}
]
}
],
"empty": false
},
"declensionTables": {
"entryGroups": [
{
"gategory": "NOUN",
"entries": [
{
"text": "{| class=\"wikitable mw-collapsible\" data-expandtext=\"näytä\" data-collapsetext=\"piilota\"')\n|-\n! colspan=\"3\"| Taivutus\n|-\n! sijamuoto !! yksikkö !! monikko\n|-\n! colspan=\"3\"| kieliopilliset sijamuodot\n|-\n| [[nominatiivi]]\n| '''koira'''\n| [[koirat#Suomi|koirat]]\n|-\n| [[genetiivi]]\n| [[koiran#Suomi|koiran]]\n| [[koirien#Suomi|koirien]]\n([[koirain#Suomi|koirain]])\n|-\n| [[partitiivi]]\n| [[koiraa#Suomi|koiraa]]\n| [[koiria#Suomi|koiria]]\n|-\n| [[akkusatiivi]]\n| '''koira'''; [[koiran#Suomi|koiran]]\n| [[koirat#Suomi|koirat]]\n|-\n! colspan=\"3\"| sisäpaikallissijat\n|-\n| [[inessiivi]]\n| [[koirassa#Suomi|koirassa]]\n| [[koirissa#Suomi|koirissa]]\n|-\n| [[elatiivi]]\n| [[koirasta#Suomi|koirasta]]\n| [[koirista#Suomi|koirista]]\n|-\n| [[illatiivi]]\n| [[koiraan#Suomi|koiraan]]\n| [[koiriin#Suomi|koiriin]]\n|-\n! colspan=\"3\"| ulkopaikallissijat\n|-\n| [[adessiivi]]\n| [[koiralla#Suomi|koiralla]]\n| [[koirilla#Suomi|koirilla]]\n|-\n| [[ablatiivi]]\n| [[koiralta#Suomi|koiralta]]\n| [[koirilta#Suomi|koirilta]]\n|-\n| [[allatiivi]]\n| [[koiralle#Suomi|koiralle]]\n| [[koirille#Suomi|koirille]]\n|-\n! colspan=\"3\"| muut sijamuodot\n|-\n| [[essiivi]]\n| [[koirana#Suomi|koirana]]\n| [[koirina#Suomi|koirina]]\n|-\n| [[translatiivi]]\n| [[koiraksi#Suomi|koiraksi]]\n| [[koiriksi#Suomi|koiriksi]]\n|-\n| [[abessiivi]]\n| [[koiratta#Suomi|koiratta]]\n| [[koiritta#Suomi|koiritta]]\n|-\n| [[instruktiivi]]\n| –\n| [[koirin#Suomi|koirin]]\n|-\n| [[komitatiivi]]\n| –\n| [[koirineen#Suomi|koirine-]]\n+ [[:Luokka:Suomen kielen omistusliitteet|omistusliite]]\n|}",
"entryLanguage": "fin",
"source": "Wiktionary"
}
]
}
],
"empty": false
}
} Fraasihaku
Kutsu
GET https://api.redfoxsanakirja.fi/redfox-api/api/dictionary/search/fin/eng/"koira osaa uida"
POST https://api.redfoxsanakirja.fi/redfox-api/api/dictionary/search
Content body (application/json)
{
"sourceLanguage": "fin",
"targetLanguage": "eng",
"text": "koira osaa uida"
} Vastaus
{
"query": {
"searchText": "koira osaa uida",
"sourceLanguage": "fin",
"destinationLanguage": "eng",
"type": "BASIC"
},
"suggestion": [],
"redfoxSecondaryTermbankTranslations": {
"empty": true
},
"redfoxThirdTermbankTranslations": {
"empty": true
},
"redfoxFourthTermbankTranslations": {
"empty": true
},
"customerTermbankTranslations": {
"empty": true
},
"translations": {
"entryGroups": [
{
"gategory": "unconfirmed",
"entries": [
{
"text": "[[the dog can swim]]",
"entryLanguage": "eng",
"source": "Microsoft translate runtime"
}
]
}
],
"empty": false
},
"additionalTranslations": {
"empty": true
},
"iateTranslations": {
"empty": true
},
"synonyms": {
"empty": true
},
"redfoxSecondaryTermbankDefinitions": {
"empty": true
},
"redfoxThirdTermbankDefinitions": {
"empty": true
},
"redfoxFourthTermbankDefinitions": {
"empty": true
},
"customerTermbankDefinitions": {
"empty": true
},
"definitions": {
"empty": true
},
"usageExamples": {
"empty": true
},
"definitionsInDestLanguage": {
"empty": true
},
"declensionTables": {
"empty": true
}
} Käännöshaku
Yksittäinen käännös
Kutsu
POST https://api.redfoxsanakirja.fi/redfox-api/api/translator/translate
Content body (application/json)
{
"sourceLanguage": "fin",
"targetLanguage": "eng",
"text": "koira osaa uida"
} Vastaus
{
"sourceLanguage": "fin",
"targetLanguage": "eng",
"text": "koira osaa uida",
"translationSource": "redfox_dictionary",
"translatedText": "The dog can swim"
} Useampi käännös
Kutsu
POST https://api.redfoxsanakirja.fi/redfox-api/api/translator/translate/batch
Content body (application/json)
[
{
"sourceLanguage": "fin",
"targetLanguage": "eng",
"text": "koira osaa uida"
},
{
"sourceLanguage": "fin",
"targetLanguage": "eng",
"text": "kissa ei osaa uida"
}
]
Vastaus
[
{
"sourceLanguage": "fin",
"targetLanguage": "eng",
"text": "koira osaa uida",
"translationSource": "redfox_dictionary",
"translatedText": "The dog can swim"
},
{
"sourceLanguage": "fin",
"targetLanguage": "eng",
"text": "kissa ei osaa uida",
"translationSource": "redfox_dictionary",
"translatedText": "cat can't swim"
}
]