提供: Japanese Scratch-Wiki

< 利用者:Jun50

Scratch APIをつかうと、Scratchにかんするさまざまなデータがしゅとくできる。

ためすばあい、いかの「リクエストれい」のURLにとぶだけでけっかがわかる。

目次

パラメーター

  • いちらんをかえすjson APIにおいて、?limit=すうじにて、こすうせいげんができる。
  • いちぶのAPIは、?offset=すうじにて、はんいしていができる。

api.scratch.mit.edu

api.scratch.mit.eduは、さいしんのScratch APIである。このAPIのURLはつぎのとおり:

https://api.scratch.mit.edu

GET /

リクエストれい

GET https://api.scratch.mit.edu

おうとうれい <sh lang="json" inline>{"website":"scratch.mit.edu","api":"api.scratch.mit.edu","help":"help@scratch.mit.edu"}</sh>

サーバーのじょうたい

GET /health

リクエストれい

GET https://api.scratch.mit.edu/health

おうとうれい

ニュース

GET /news

リクエストれい

GET https://api.scratch.mit.edu/news

おうとうれい

GET /projects/count/all

リクエストれい

GET https://api.scratch.mit.edu/projects/count/all

おうとうれい <sh lang="json" inline>{"count":22850560}</sh>

さいきんのようす

GET /proxy/featured

リクエストれい

GET https://api.scratch.mit.edu/proxy/featured

おうとうれい

GET /proxy/users/<username>/activity

リクエストれい

GET https://api.scratch.mit.edu/proxy/users/abee/activity

おうとうれい

GET /proxy/users/<username>/activity/count (はいし)

リクエストれい

GET https://api.scratch.mit.edu/proxy/users/Paddle2See/activity/count

おうとうれい <sh lang="json"> {

 "msg_count": 14

} </sh>

ユーザー

GET /users/<username>

リクエストれい

GET https://api.scratch.mit.edu/users/apple502j

おうとうれい

GET /users/<username>/favorites

リクエストれい

GET https://api.scratch.mit.edu/users/ScratchCat/favorites

おうとうれい

GET /users/<username>/followers

リクエストれい

GET https://api.scratch.mit.edu/users/thisandagain/followers

おうとうれい

GET /users/<username>/following

リクエストれい

GET https://api.scratch.mit.edu/users/Paddle2See/following

おうとうれい

GET /users/<username>/messages/count

リクエストれい

GET https://api.scratch.mit.edu/users/Paddle2See/messages/count

おうとうれい <sh lang="json"> {

 "count": 14

} </sh>

GET /users/<username>/studios/curate/

リクエストれい

GET https://api.scratch.mit.edu/users/ScratchCat/studios/curate/

おうとうれい

GET /users/<username>/projects

リクエストれい

GET https://api.scratch.mit.edu/users/ScratchCat/projects

おうとうれい

プロジェクトのとうけい

GET /projects/<project_id>/

リクエストれい

GET https://api.scratch.mit.edu/projects/103530008

おうとうれい: うえとおなじ。

GET /projects/<project_id>/remixes/

リクエストれい

GET https://api.scratch.mit.edu/projects/103530008/remixes/

おうとうれい

GET /projects/<project-id>/studios/

リクエストれい

GET https://api.scratch.mit.edu/projects/103530008/studios/

おうとうれい

コメントAPI

GET /projects/<project-id>/comments/

リクエストれい

GET https://api.scratch.mit.edu/projects/103530008/comments/

おうとうれい

GET /project/<project-id>/comments/<parent-id>/replies/

リクエストれい

GET https://api.scratch.mit.edu/projects/203791193/comments/98229863/replies/

おうとうれい

きょうしようアカウントAPI

GET /classrooms/<classroom-id>/

リクエストれい

GET https://api.scratch.mit.edu/comments/project/203791193/98229863/

おうとうれい

けんさく

qパラメータがないばあい、にんきのものがかえるのでちゅうい。

GET https://api.scratch.mit.edu/search/projects/?q=<word>

リクエストれい

GET https://api.scratch.mit.edu/search/projects?q=Japan

おうとうれい

GET https://api.scratch.mit.edu/search/studios?q=<word>

リクエストれい

GET https://api.scratch.mit.edu/search/studios?q=Wiki

おうとうれい

ユーザー名API

「username exists」(すでにそんざい)「bad username」(けんえつ)「invalid username」(むこう)「valid username」(しようかのう)を返す。

GET /accounts/check_username/<word>

リクエストれい

GET https://scratch.mit.edu/accounts/check_username/UnavailableUser/

おうとうれい

scratch.mit.edu/site-api

GET comments/gallery/<studio_id>/

コメントをしゅとくする。 リクエストれい

GET https://scratch.mit.edu/site-api/comments/gallery/5342/

GET /comments/project/<project_id>/

コメントをしゅとくする。 リクエストれい

GET https://scratch.mit.edu/site-api/comments/project/103345354/

GET /comments/user/<username>/

コメントをしゅとくする。 リクエストれい

GET https://scratch.mit.edu/site-api/comments/user/thisandagain/

PUT /users/followers/<username>/add/

フォローする。 リクエストれい

PUT https://scratch.mit.edu/site-api/users/followers/abee/add/

PUT /users/lovers/<project_id>/add/

「すき」を入れる。 リクエストれい

PUT https://scratch.mit.edu/site-api/users/lovers/154080544/add/

PUT /users/favoriters/<project_id>/add/

「おきにいり」にする。 リクエストれい

PUT https://scratch.mit.edu/site-api/users/favoriters/154080544/add/

PUT /users/all/<username>

「わたしについて」「わたしがとりくんでいること」の変更。 リクエストれい

PUT https://scratch.mit.edu/site-api/users/all/apple502j

必要なヘッダー

X-CSRFTokenというヘッダーに、トークンを設定する。トークンはCookieの「scratchcsrftoken」をさんしょうすればいい。また、X-Requested-WithにはXMLHttpRequestをしていする。

Cookieは、scratchcsrftokenとscratchsessionsidがひつようだ。

varserver api (はいし)

クラウドへんすうのAPI。

GET /<project_id>

リクエストれい

GET https://scratch.mit.edu/varserver/16805451

おうとうれい <sh lang="json"> {

 "variables": [
   {
     "name": "☁ たたかれた回数",
     "value": "2546"
   }
 ],
 "lists": []

} </sh>

api/v1 API (しようふか)

GET /

リクエストれい

GET https://scratch.mit.edu/api/v1/

おうとうれい <sh lang="json"> {

 "project": {
   "list_endpoint": "/api/v1/project/",
   "schema": "/api/v1/project/schema/"
 },
 "projecttag": {
   "list_endpoint": "/api/v1/projecttag/",
   "schema": "/api/v1/projecttag/schema/"
 },
 "tag": {
   "list_endpoint": "/api/v1/tag/",
   "schema": "/api/v1/tag/schema/"
 },
 "user": {
   "list_endpoint": "/api/v1/user/",
   "schema": "/api/v1/user/schema/"
 }

}</sh>

GET /project/<project_id>/

リクエストれい

GET https://scratch.mit.edu/api/v1/project/178040314

おうとうれい

GET /project/set/<project_ids>/

リクエストれい

GET https://scratch.mit.edu/api/v1/project/set/169147225;178040314/

おうとうれい

GET /user/<username>/

リクエストれい

GET https://scratch.mit.edu/api/v1/user/mres/

おうとうれい

GET /user/set/<usernames>/

げんざいしようできない。 リクエストれい

GET https://scratch.mit.edu/api/v1/user/set/ScratchCat;thisandagain/

おうとうれい <sh lang="json"> {

 "objects": [
   {
     "username": "ScratchCat",
     "userprofile": ""
   },
   {
     "username": "thisandagain",
     "userprofile": ""
   }
 ]

}</sh>

プロジェクトそざいのAPI

プロジェクトのJSON

JSONハッキングにつかうJSONとおなじものがかえる。 リクエストれい

GET https://projects.scratch.mit.edu/internalapi/project/102747129/get/

おうとうれい

そざい

リクエストれい

GET https://cdn.assets.scratch.mit.edu/internalapi/asset/5e037aca5446a7e57093e45fe6f18c9e.svg/get/

おうとうれい