{"info":{"_postman_id":"ba33ea59-5dcb-4fd9-818a-6c7c181ea40f","name":"Elaisa API","description":"

API documentation for the Elaisa Search project. www.elaisa.org

Each request needs the key parameter, whose value is your api key. If you have no api key yet, please contact info@elaisa.org.

Important:

If you forget to add the key parameter, the API will return the following:

{\n    \"error\": \"API-KEY is wrong or missing. See https://github.com/dasmemeteam/language-level-search-engine/blob/master/bin/README.md for more information.\"\n}\n

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"2560401","collectionId":"ba33ea59-5dcb-4fd9-818a-6c7c181ea40f","publishedId":"SVtbR627","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2019-10-21T12:22:17.000Z"},"item":[{"name":"Get Result Documentts","id":"88e6710e-0f74-4fc3-9bb5-f09df1194494","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"api.elaisa.org/find?query=UK&level=all&language=en&loggedin=false&email=frodo.beutlin@hobbits.com&mode=compact&exclude=wikipedia,documents&key","description":"

This endpoint returns all documents filtered by the given parameters.

There are two more optional parameters you can use to filter the results:

mode
- Types:
  - „compact“
    - Removes the text and links from each item
    \n
  - „analysis“
    - Only returns the item’s url, level and level_meta
    \n
  \n
- The pagerank and _id are always returned by the API
- Example:
  - …/find&mode=compact
  \n
\n
exclude:
- Exclude the wikipedia or/and document object from the API’s result, thus the result is less huge and less data will be sent.
- Example:\n - …/find&exclude=wikipedia,documents
  \n
\n

Response

mode: compact
Exclude: wikipedia,documents

{\n    \"result\": {\n        \"spellcheck\": {\n            \"checked\": false,\n            \"correctquery\": \"\"\n        },\n        \"wikipedia\": {},\n        \"documents\": {}\n    }\n}\n

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"key"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"ba33ea59-5dcb-4fd9-818a-6c7c181ea40f","id":"ba33ea59-5dcb-4fd9-818a-6c7c181ea40f","name":"Elaisa API","type":"collection"}},"urlObject":{"path":["find"],"host":["api","elaisa","org"],"query":[{"key":"query","value":"UK"},{"key":"level","value":"all"},{"key":"language","value":"en"},{"key":"loggedin","value":"false"},{"key":"email","value":"frodo.beutlin@hobbits.com"},{"key":"mode","value":"compact"},{"key":"exclude","value":"wikipedia,documents"},{"key":"key","value":null}],"variable":[]}},"response":[],"_postman_id":"88e6710e-0f74-4fc3-9bb5-f09df1194494"},{"name":"Change Password","id":"a84d23bb-7cd7-4d8f-8ae8-3dfbd84cd25c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"api.elaisa.org/changepassword?oldpassword=password1&newpassword=password2&email=max@mustermann.de&key=","description":"

This endpoint changes the password of a specific user.

Response

{\n    \"result\": {\n        \"email\": \"max@mustermann.de\",\n        \"message\": \"success\"\n    }\n}\n

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"key"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"ba33ea59-5dcb-4fd9-818a-6c7c181ea40f","id":"ba33ea59-5dcb-4fd9-818a-6c7c181ea40f","name":"Elaisa API","type":"collection"}},"urlObject":{"path":["changepassword"],"host":["api","elaisa","org"],"query":[{"key":"oldpassword","value":"password1"},{"key":"newpassword","value":"password2"},{"key":"email","value":"max@mustermann.de"},{"key":"key","value":""}],"variable":[]}},"response":[],"_postman_id":"a84d23bb-7cd7-4d8f-8ae8-3dfbd84cd25c"},{"name":"Get Search History","id":"8b73a9bf-7c46-4a5b-b29f-8157010e3d65","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"api.elaisa.org/searchhistory?email=max@mustermann.de&key=","description":"

This endpoint returns the entire search history of a logged in user. If a user is logged in to his/her account, the API will add the latest search to the history.

Response

{\n    \"result\": {\n        \"email\": \"max@mustermann.de\",\n        \"statistics\": {\n            \"language\": {\n                \"en\": 0,\n                \"es\": 0,\n                \"de\": 0\n            },\n            \"level\": {\n                \"all\": 0,\n                \"a1\": 0,\n                \"a2\": 0,\n                \"b1\": 0,\n                \"b2\": 0,\n                \"c1\": 0,\n                \"c2\": 0\n            }\n        },\n        \"history\": []\n    }\n}\n

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"key"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"ba33ea59-5dcb-4fd9-818a-6c7c181ea40f","id":"ba33ea59-5dcb-4fd9-818a-6c7c181ea40f","name":"Elaisa API","type":"collection"}},"urlObject":{"path":["searchhistory"],"host":["api","elaisa","org"],"query":[{"key":"email","value":"max@mustermann.de"},{"key":"key","value":""}],"variable":[]}},"response":[],"_postman_id":"8b73a9bf-7c46-4a5b-b29f-8157010e3d65"},{"name":"Get Inverted Index Words","id":"21e9a783-862d-4608-bff9-57b2a04ae463","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"api.elaisa.org/getwords","description":"

Returns all words from the inverted index. Is used for autocompletion in the user interface.

Response

{\n    \"result\": [\n        {\n            \"word\": \"summer\"\n        }\n    ]\n}\n

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"key"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"ba33ea59-5dcb-4fd9-818a-6c7c181ea40f","id":"ba33ea59-5dcb-4fd9-818a-6c7c181ea40f","name":"Elaisa API","type":"collection"}},"urlObject":{"path":["getwords"],"host":["api","elaisa","org"],"query":[],"variable":[]}},"response":[],"_postman_id":"21e9a783-862d-4608-bff9-57b2a04ae463"},{"name":"Sign Up","id":"0d50512d-2f36-4c04-b99f-f537325cfedf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[]},"url":"api.elaisa.org/signup?firstname=Max&lastname=Mustermann&email=max@mustermann.de&password=password1&key=","description":"

Creates a new user account if the user isn't stored yet.

Response

Message will be already exists if the user already has an account.

{\n    \"result\": {\n        \"email\": \"max@mustermann.de\",\n        \"message\": \"success\",\n        \"user\": {\n            \"email\": \"max@mustermann.de\",\n            \"firstname\": \"Max\",\n            \"lastname\": \"Mustermann\"\n        }\n    }\n}\n

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"key"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"ba33ea59-5dcb-4fd9-818a-6c7c181ea40f","id":"ba33ea59-5dcb-4fd9-818a-6c7c181ea40f","name":"Elaisa API","type":"collection"}},"urlObject":{"path":["signup"],"host":["api","elaisa","org"],"query":[{"key":"firstname","value":"Max"},{"key":"lastname","value":"Mustermann"},{"key":"email","value":"max@mustermann.de"},{"key":"password","value":"password1"},{"key":"key","value":""}],"variable":[]}},"response":[],"_postman_id":"0d50512d-2f36-4c04-b99f-f537325cfedf"},{"name":"Sign In","id":"144828bf-3768-4c41-acff-8a86d0c8041b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"api.elaisa.org/signin?email=max@mustermann.de&password=password1&key=","description":"

Signs in an existing user.

Response

Message will be error if username or password are wrong. Futhermore, the API will return status 500.

{\n    \"result\": {\n        \"email\": \"max@mustermann.de\",\n        \"message\": \"success\",\n        \"user\": {\n            \"email\": \"max@mustermann.de\",\n            \"firstname\": \"Max\",\n            \"lastname\": \"Mustermann\"\n        }\n    }\n}\n

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"key"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"ba33ea59-5dcb-4fd9-818a-6c7c181ea40f","id":"ba33ea59-5dcb-4fd9-818a-6c7c181ea40f","name":"Elaisa API","type":"collection"}},"urlObject":{"path":["signin"],"host":["api","elaisa","org"],"query":[{"key":"email","value":"max@mustermann.de"},{"key":"password","value":"password1"},{"key":"key","value":""}],"variable":[]}},"response":[],"_postman_id":"144828bf-3768-4c41-acff-8a86d0c8041b"},{"name":"Get Topics","id":"d9f9fb4d-cc4e-47b9-ae3d-83d59c70732e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"api.elaisa.org/gettopics?number=3","description":"

Get random topics from the inverted index to provide a default search feature.

You don't need an API-Key for this request, while the response will look like the following:

{\n    \"result\": {\n        \"length\": 3,\n        \"topics\": [\n            {\n                \"topic\": \"Marin\",\n                \"documents_count\": 51\n            },\n            {\n                \"topic\": \"Foyth\",\n                \"documents_count\": 21\n            },\n            {\n                \"topic\": \"Ndombele\",\n                \"documents_count\": 29\n            }\n        ]\n    }\n}\n

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"key"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"ba33ea59-5dcb-4fd9-818a-6c7c181ea40f","id":"ba33ea59-5dcb-4fd9-818a-6c7c181ea40f","name":"Elaisa API","type":"collection"}},"urlObject":{"path":["gettopics"],"host":["api","elaisa","org"],"query":[{"key":"number","value":"3"}],"variable":[]}},"response":[],"_postman_id":"d9f9fb4d-cc4e-47b9-ae3d-83d59c70732e"},{"name":"Categorizer - Get Language Level","id":"fe342465-e728-4350-8297-a291840b2f11","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"categorizer.api.elaisa.org/getlanguagelevel?text=in Germany there are a lot of people playing football nowadays.&language=en&key=","description":"

This endpoint retuerns the CEFR level information of an input text.

RESPONSE

{\n    \"result\": {\n        \"level\": \"A1\",\n        \"difficulty\": \"hard\",\n        \"level_meta\": {\n            \"unknown\": 0,\n            \"A1\": 64,\n            \"A2\": 0,\n            \"B1\": 9,\n            \"B2\": 0,\n            \"C1\": 0,\n            \"C2\": 0\n        }\n    }\n}\n

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"key"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"ba33ea59-5dcb-4fd9-818a-6c7c181ea40f","id":"ba33ea59-5dcb-4fd9-818a-6c7c181ea40f","name":"Elaisa API","type":"collection"}},"urlObject":{"path":["getlanguagelevel"],"host":["categorizer","api","elaisa","org"],"query":[{"key":"text","value":"in Germany there are a lot of people playing football nowadays."},{"key":"language","value":"en"},{"key":"key","value":""}],"variable":[]}},"response":[],"_postman_id":"fe342465-e728-4350-8297-a291840b2f11"}],"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"key"},{"key":"value","value":""}]}},"event":[{"listen":"prerequest","script":{"id":"603e0857-817d-43e2-a6d0-8dc3e435661f","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"67b4b91a-c9b9-4947-982b-2b4c7019baec","type":"text/javascript","exec":[""]}}]}

Example:\n - …/find&exclude=wikipedia,documents

Response

Response

Response

Response

Response

Response