API fyrir forritara

Búðu til verkefni úr þínu eigin kerfi

Ein POST-fyrirspurn fyrir hverja tegund verkefnis. Sendu efnið þitt sem JSON og fáðu til baka verkefni í Puzzel.org-aðgangnum þínum og vefslóð sem þú getur afhent leikmönnum eða sett inn í iframe.

Grunnslóð: https://puzzel.org/api/public/v1
Auðkenning: Lykill + netfang í meginmáli
Endapunktar: 20 tegundir verkefna
Kvóti: 10 verkefni á dag

Fyrsta fyrirspurnin þín

Ekkert að setja upp og enga tengimyndun þarf: sendu JSON-meginmál með lyklinum þínum, netfanginu þínu og efninu þínu. Svarið inniheldur lykil nýja verkefnisins og vefslóðina sem það er spilað á.

POST crossword

curl -X POST https://puzzel.org/api/public/v1/crossword \
  -H "Content-Type: application/json" \
  -d '{
  "account_api_key": "YOUR_API_KEY",
  "email": "you@example.com",
  "title": "Crossword",
  "language": "is",
  "items": [
    {
      "answer": "BANANA",
      "description": "A long yellow fruit",
      "type": "text"
    },
    {
      "answer": "CHERRY",
      "description": "A small red stone fruit",
      "type": "text"
    },
    {
      "answer": "MELON",
      "description": "Big, green outside, sweet inside",
      "type": "text"
    }
  ]
}'

Tókst

{
  "success": true,
  "id": "-Nq8sample_activity_key",
  "url": "https://puzzel.org/en/crossword/embed?p=-Nq8sample_activity_key",
  "message": "Crossword created successfully"
}

Sérhvert dæmi á þessari síðu er heil, keyranleg fyrirspurn. Skiptu út fyrir þinn eigin lykil og efni og hún virkar eins og hún er.

Auðkenning

Það eru engin headers og enginn bearer token. Bæði auðkennin ferðast í JSON-meginmáli hverrar fyrirspurnar, og lykillinn er aðeins samþykktur fyrir þann aðgang sem netfangið tilheyrir.

Reitur	Tegund	Hvað hann gerir
`account_api_key` nauðsynlegt string	string	API-lykill aðgangsins þíns. Hann fer í meginmálið, ekki í header.
`email` nauðsynlegt string	string	Netfangið sem Puzzel.org-aðgangurinn þinn skráir sig inn með. Lykillinn er aðeins gildur ásamt því.

Lykillinn þinn er í aðgangshluta stjórnborðsins þíns, á bak við Sýna.

Skrá inn

API-lyklar eru afhentir þegar áskrift hefst, svo ókeypis aðgangur hefur ekki fengið sinn ennþá.

Skoða áskriftarleiðirnar

Farðu með lykilinn eins og lykilorð. Hann býr til og skrifar yfir verkefni í aðgangnum þínum, svo geymdu hann á vefþjóninum og haltu honum utan alls sem vafri getur lesið.

Meginmál fyrirspurnarinnar

Sérhver endapunktur tekur við sömu fimm reitunum. Það sem er breytilegt er content-reiturinn undir þeim: flestir taka fylki af items, sumir taka eina setningu eða eina mynd, og Sudoku tekur ekkert.

Reitur	Tegund	Hvað hann gerir
`account_api_key` nauðsynlegt string	string	API-lykill aðgangsins þíns. Hann fer í meginmálið, ekki í header.
`email` nauðsynlegt string	string	Netfangið sem Puzzel.org-aðgangurinn þinn skráir sig inn með. Lykillinn er aðeins gildur ásamt því.
`title` valfrjálst string	string	Heitið sem verkefnið fær í stjórnborðinu þínu. Sleppirðu því notar endapunkturinn sitt eigið sjálfgefna heiti.
`language` valfrjálst string	string	Ákveður aðeins málsvæðið í vefslóðinni sem þú færð til baka — þýðir ekki neitt af innihaldinu sem þú sendir. Orðaleit les þennan reit líka til að skipta fyllistöfunum sínum yfir í arabísku þegar gildið er "ar". Sjálfgefið: "en"
`activity_key` valfrjálst string	string	Sleppirðu því býrðu til nýtt verkefni. Sendirðu lykil verkefnis sem þú átt nú þegar er það verkefni endurbyggt í staðinn.

settings er hlutur með valkostum fyrir hvern endapunkt. Hvaða valkosti hver endapunktur les er talið upp hér fyrir neðan; allt annað sem þú setur þar er hunsað.

Það sem kemur til baka

Fyrirspurn sem heppnast svarar með 200 og skilar lykli nýja verkefnisins og vefslóðinni sem það er spilað á. Allt annað svarar með success sett á false og einum villustreng.

Tókst

{
  "success": true,
  "id": "-Nq8sample_activity_key",
  "url": "https://puzzel.org/en/crossword/embed?p=-Nq8sample_activity_key",
  "message": "Crossword created successfully"
}

Mistókst

{
  "success": false,
  "error": "Invalid Email or API Key"
}

Vefslóðin sem þú færð til baka er innfellingarútgáfan. Skiptu embed út fyrir play til að opna hana á heilli síðu, eða fyrir build til að opna hana í ritlinum — lykillinn eftir p= helst óbreyttur.

Að búa til eða uppfæra

Sendirðu activity_key er verkefnið á bak við hann endurbyggt á sínum stað: efni þess er skipt út, heiti þess og útgáfustimpill eru uppfærð, og lykillinn sjálfur helst óbreyttur — svo tenglar og innfellingar sem þú hefur þegar deilt halda áfram að virka. Niðurstöður, möppustaðsetning og allar stillingar sem endapunkturinn skrifar ekki sjálfur halda sér óbreyttar.

activity_key

{
  "account_api_key": "YOUR_API_KEY",
  "email": "you@example.com",
  "activity_key": "-Nq8sample_activity_key",
  "title": "Fruit crossword, week 2",
  "items": [
    {
      "answer": "BANANA",
      "description": "A long yellow fruit",
      "type": "text"
    },
    {
      "answer": "CHERRY",
      "description": "A small red stone fruit",
      "type": "text"
    },
    {
      "answer": "MELON",
      "description": "Big, green outside, sweet inside",
      "type": "text"
    }
  ]
}

title er beitt við hverja uppfærslu, sjálfgefna gildið meðtalið — sleppirðu því er verkefnið endurnefnt í sjálfgefið heiti þess endapunkts.
Stillingablokkirnar sem endapunktur skrifar sjálfur eru endurskrifaðar frá grunni, svo uppfærsla núllstillir þær líka á gildin sem þú sendir, eða á sjálfgefin gildi endapunktsins.
Þú getur aðeins uppfært verkefni sem þinn eigin aðgangur á. Lykill einhvers annars svarar með 403.
Uppfærsla kostar það sama og að búa til nýtt: eina fyrirspurn af kvóta dagsins.

Tíðnitakmörk

10 verkefni á hvern aðgang á dag

Sérhver fyrirspurn sem heppnast telur, hvort sem hún býr til eða uppfærir. Farirðu yfir mörkin svarar næsta fyrirspurn með 429 þar til teljarinn er hreinsaður.

Teljarinn er hreinsaður einu sinni á dag af tímasettu verki, ekki á fljótandi 24 klukkustunda glugga.

Villur

Villur berast alltaf sem JSON með sömu tveimur reitunum, aldrei sem HTML-síða. Villustrengurinn er skrifaður til að fólk geti lesið hann — hann nefnir reitinn eða mörkin sem brugðust.

Staða	Hvað hún þýðir
`400` Bad Request	Eitthvað í meginmálinu vantar, er rangt sniðið eða utan marka. Skilaboðin nefna reitinn.
`401` Unauthorized	Netfangið er óþekkt, eða lykillinn tilheyrir ekki þeim aðgangi.
`403` Forbidden	activity_key sem þú sendir tilheyrir öðrum aðgangi.
`429` Too Many Requests	Kvóti dagsins er búinn. Hann hreinsast einu sinni á dag.
`500` Server Error	Smiðjan gat ekki búið til þraut úr því sem þú sendir — oftast of fá orð, eða orð sem er ekki hægt að raða saman.

Endapunktar

Ein slóð fyrir hverja tegund verkefnis, allar POST, allar undir sömu grunnslóðinni. Hver þeirra sýnir efnið sem hún þarf, stillingarnar sem hún les og fyrirspurn sem þú getur keyrt.

Orð og stafir

Krossgáta

Fléttar svörin þín saman í reitanet og númerar skýringarnar fyrir þig.

POST /api/public/v1/crossword Að minnsta kosti 2 í items

Efni

Fylki af orðum. Hver færsla parar svarið við skýringuna sem vísar á það.

Fellur til baka á heitið “Crossword API”

Vert að vita

Svör sem eru styttri en tveir stafir eru felld út áður en reitanetið er búið til, og að minnsta kosti tvö verða að lifa það af.
Svör eru sett í hástafi og smiðjan fær tuttugu tilraunir til að koma þeim fyrir. Ef hún getur ekki komið fyrir einu einasta orði svarar fyrirspurnin með 500.

Dæmi um fyrirspurn

POST crossword

curl -X POST https://puzzel.org/api/public/v1/crossword \
  -H "Content-Type: application/json" \
  -d '{
  "account_api_key": "YOUR_API_KEY",
  "email": "you@example.com",
  "title": "Crossword",
  "language": "is",
  "items": [
    {
      "answer": "BANANA",
      "description": "A long yellow fruit",
      "type": "text"
    },
    {
      "answer": "CHERRY",
      "description": "A small red stone fruit",
      "type": "text"
    },
    {
      "answer": "MELON",
      "description": "Big, green outside, sweet inside",
      "type": "text"
    }
  ]
}'

Tókst

{
  "success": true,
  "id": "-Nq8sample_activity_key",
  "url": "https://puzzel.org/en/crossword/embed?p=-Nq8sample_activity_key",
  "message": "Crossword created successfully"
}

Reitur	Tegund	Hvað hann gerir
`hidden_solution` valfrjálst í settings string	string	Afgangsstafirnir mynda þetta. Sért þessi stilling notuð segir hún smiðjunni líka að koma lausninni fyrir fyrst, frekar en að troða inn eins mörgum orðum og hún getur.
`directions` valfrjálst í settings string[]	string[]	Í hvaða áttir orð mega liggja. Sleppirðu þessu liggja orð aðeins til austurs, suðausturs og suðurs. Eitt af `westeastnorthsouthnorthwestnortheastsouthwestsoutheast` Sjálfgefið: ["east", "southeast", "south"]
`template` valfrjálst í settings string	string	Sker reitanetið í ákveðið form í stað þess að láta það vera ferkantað. Eitt af `squarecirclecrossdiamondpyramidsmileystarcross_plus`

Reitur	Tegund	Hvað hann gerir
`number_of_tiles` valfrjálst í settings number	number	Hversu marga reiti borðið hefur. Milli 10 og 75. Sjálfgefið: 30
`game_mode` valfrjálst í settings string	string	Hvort leikmenn keppa að marklínu eða safna hlutum á leiðinni. Eitt af `race_to_finishcollect_items` Sjálfgefið: "race_to_finish"

Reitur	Tegund	Hvað hann gerir
`sentence` nauðsynlegt string	string	Setningin sem á að dulrita. Leikmenn ráða hana staf fyrir staf.
`helpers` valfrjálst í settings string	string	Hvaða stafir eru gefnir frítt sem leið inn í þrautina: engir, þeir algengustu, sérhljóðarnir, eða þeir sem þú telur upp. Eitt af `nonemost_commonvowelscustom` Sjálfgefið: "none"
`character_list` valfrjálst í settings string	string	Stafrófið sem dulmálið er byggt á. Sé það haft tómt velur dulritunin sitt eigið.
`extra_letters` valfrjálst í settings string	string	Stafirnir sem eru gefnir þegar helpers er "custom". Hunsað fyrir aðra hjálparhami.
`hide_unused_characters` valfrjálst í settings boolean	boolean	Sleppir stöfum sem setningin notar aldrei úr lyklinum. Sjálfgefið: false

Reitur	Tegund	Hvað hann gerir
`sentence` nauðsynlegt string	string	Setningin sem leikmenn afhjúpa með því að leysa reikningsdæmin.
`difficulty_level` valfrjálst í settings number	number	Hæsta svar sem reikningsdæmi má hafa. Eitt af `20501001000` Sjálfgefið: "100"
`operators` valfrjálst í settings string[]	string[]	Hvaða reikniaðgerðir mega koma fyrir. x er margföldun, : er deiling. Eitt af `+-x:` Sjálfgefið: ["+", "-", "x", ":"]
`max_operations` valfrjálst í settings number	number	Hversu margar aðgerðir eitt reikningsdæmi má tengja saman. Eitt af `123` Sjálfgefið: 1
`number_difficulty` valfrjálst í settings number	number	Takmarkar einstakar tölur innan í reikningsdæmi. Allt frá 5 upp í 1000. Sjálfgefið: 100

Reitur	Tegund	Hvað hann gerir
`size` valfrjálst í settings string	string	Stærð eins reits, skrifuð sem raðir sinnum dálkar — 3x3 gefur hið klassíska 9x9 reitanet. Endapunkturinn athugar aðeins að þetta séu tvær tölur, svo haltu þig við þær stærðir sem ritillinn býður upp á. Eitt af `2x22x33x33x44x4` Sjálfgefið: "3x3"
`difficulty_level` valfrjálst í settings string	string	Hversu margar tölur eru skildar eftir á borðinu til að byrja með. Eitt af `easynormalhard` Sjálfgefið: "normal"

Búðu til verkefni úr þínu eigin kerfi

Fyrsta fyrirspurnin þín

Auðkenning

Meginmál fyrirspurnarinnar

Það sem kemur til baka

Að búa til eða uppfæra

Tíðnitakmörk

Villur

Endapunktar

Eitthvað sem virkar ekki rétt?