{"id":79,"date":"2015-08-07T10:05:57","date_gmt":"2015-08-07T10:05:57","guid":{"rendered":"http:\/\/is.ieis.tue.nl\/research\/hc\/gamebus\/?page_id=79"},"modified":"2015-08-07T10:05:57","modified_gmt":"2015-08-07T10:05:57","slug":"api","status":"publish","type":"page","link":"https:\/\/blog.gamebus.eu\/index.php\/sample-page\/api\/","title":{"rendered":"GameBus API"},"content":{"rendered":"

API Endpoint<\/h2>\n

http:islab1.ieis.tue.nl:8024\/api<\/p>\n

 <\/p>\n

Authentication<\/h2>\n

An access token is necessary to be used in each request.<\/p>\n

 <\/p>\n

Summary of resources<\/h2>\n

\/user<\/p>\n

\/player<\/p>\n

\/challenge<\/p>\n

\/gameDescriptor<\/p>\n

\/property<\/p>\n

\/propertyType<\/p>\n

\/propertyInstance<\/p>\n

\/gameSession<\/p>\n

\/tag<\/p>\n

\/dataProvider<\/p>\n

\/tokenForDataProvider<\/p>\n

\/rointMapping<\/p>\n

\/role<\/p>\n

\/support<\/p>\n

\/circle<\/p>\n

\/personalPoint<\/p>\n

\/participation<\/p>\n

\/reward<\/p>\n

\/sponsor<\/p>\n

\/rightToShowChallenge<\/p>\n

\/challengeRule<\/p>\n

\/condition<\/p>\n

\/operator<\/p>\n

To perform an operation on any of the above listed resources, you just need to append the resource as it is, with the API endpoint. Of course it varies from request to request, so for example in case of GET and DELETE you just append the resource to the endpoint but for POST or PUT you need to specify the parameters and their values accordingly. For details, see the relevant sections for those methods.<\/p>\n

<\/h2>\n

Request pattern<\/h2>\n

curl -X $Method -H “Authorization: Bearer $token” http:\/\/islab1.ieis.tue.nl:8024\/api\/player<\/a><\/p>\n

In this request, the variable with $ sign needs to be replaced by its values. For example, in the example request below we have replaced $Method with GET and $token with the value of the access token.<\/p>\n

Example request<\/h2>\n

curl -X GET -H “Authorization: Bearer 797d8861-1436-4bd5-97c2-2e7bd9884749” http:\/\/islab1.ieis.tue.nl:8024\/api\/player<\/a><\/p>\n

 <\/p>\n

Sample response for the same request above, but when executed from a REST client.<\/p>\n

 <\/p>\n

Get a Token via Login service<\/h2>\n

 <\/p>\n

Get the OAUTH token<\/p>\n

curl -X POST -H “Content-Type: application\/x-www-form-urlencoded” -d “grant_type=password” -d “username=testuser@example.com” -d “password=testpass” http:\/\/$gamebus:secret@localhost:8989\/oauth\/token | jq<\/span> -r ‘.access_token’<\/p>\n

connection refused<\/p>\n

 <\/p>\n

curl -X GET -H “Content-Type: application\/x-www-form-urlencoded” -d “grant_type=password” -d “username=testuser@example.com” -d “password=testpass” http:\/\/gamebus:secret@localhost:8989\/oauth\/token | jq<\/span> -r ‘.access_token’<\/p>\n

connection refused<\/p>\n

 <\/p>\n

Get token (out of script) returns null<\/p>\n

curl -X POST -H “Content-Type: application\/x-www-form-urlencoded<\/span>” -d “grant_type=password” -d “username=testuser@example.com” -d “password=testpass” http:\/\/gamebus:@localhost:8989\/oauth\/token | jq<\/span> -r ‘.access_token’<\/p>\n

Failed to connect to localhost port 8989: connection refused<\/p>\n

 <\/p>\n

curl -X GET -H “Content-Type: application\/x-www<\/span>-form-urlencoded<\/span>” -d “grant_type=password” -d “username=testuser@example.com” -d “password=testpass” http:\/\/gamebus:@localhost:8989\/oauth\/token | jq<\/span> -r ‘.access_token’<\/p>\n

Failed to connect to localhost port 8989: connection refused<\/p>\n

curl curl:testpass@localhost:8989\/oauth\/token\\?grant_type=client_credentials<\/p>\n

 <\/p>\n

curl curl:testpass@localhost:8989\/oauth\/token\\?grant_type=password<\/p>\n

 <\/p>\n

Insert a GameDescriptor<\/h2>\n

curl -H “Authorization: Bearer 108cf321-06c1-4d30-bb2c-d7904b87cc6e” -X POST -H “Content-Type: application\/json” -d “{\\”name\\”: \\”Memory\\”, \\”tag\\”: \\”cognitive\\”}” http:\/\/localhost:8989\/api\/gameDescriptor<\/a><\/p>\n

#Retrieve all the gameDescriptors<\/p>\n

curl -X GET -H “Authorization: Bearer 108cf321-06c1-4d30-bb2c-d7904b87cc6e” http:\/\/localhost:8989\/api\/gameDescriptor<\/a><\/p>\n

#Based on Id of a (chosen) gameDescriptor, post a new GameSession<\/p>\n

curl -H “Authorization: Bearer 108cf321-06c1-4d30-bb2c-d7904b87cc6e” -X POST -H “Content-Type: application\/json” -d “{\\”createdAt\\”: \\”07-07-2015\\”, \\”isManual\\”: \\”true\\”}” http:\/\/localhost:8989\/api\/gameDescriptor\/1\/gameSession<\/a><\/p>\n

Retrieving resources:<\/h1>\n

curl -X GET -H “Authorization: Bearer 108cf321-06c1-4d30-bb2c-d7904b87cc6e” http:\/\/localhost:8989\/api\/player<\/a><\/p>\n

curl -X GET -H “Authorization: Bearer 108cf321-06c1-4d30-bb2c-d7904b87cc6e” http:\/\/localhost:8989\/api\/user<\/a><\/p>\n

curl -X GET -H “Authorization: Bearer 108cf321-06c1-4d30-bb2c-d7904b87cc6e” http:\/\/localhost:8989\/api\/gameDescriptor<\/a><\/p>\n

 <\/p>\n

#Get a specific player with id (or entity likewise)<\/p>\n

curl -X GET -H “Authorization: Bearer 108cf321-06c1-4d30-bb2c-d7904b87cc6e” http:\/\/localhost:8989\/api\/player\/2<\/a><\/p>\n

#Get circles for a player with id<\/p>\n

curl -X GET -H “Authorization: Bearer 108cf321-06c1-4d30-bb2c-d7904b87cc6e ” http:\/\/localhost:8989\/api\/player\/2\/circles<\/a><\/p>\n

curl -X GET -H “Authorization: Bearer 108cf321-06c1-4d30-bb2c-d7904b87cc6e” http:\/\/localhost:8989\/api\/player\/2\/supports<\/a><\/p>\n

curl -X GET -H “Authorization: Bearer 108cf321-06c1-4d30-bb2c-d7904b87cc6e” http:\/\/localhost:8989\/api\/player\/2\/gameSessions<\/a><\/p>\n

 <\/p>\n

curl -X GET -H “Authorization: Bearer 108cf321-06c1-4d30-bb2c-d7904b87cc6e” http:\/\/localhost:8989\/api\/player\/2\/tokensForDataProvider<\/a><\/p>\n

 <\/p>\n

Creation of resources<\/h1>\n

Create a user<\/p>\n

curl -H “Authorization: Bearer 108cf321-06c1-4d30-bb2c-d7904b87cc6e” -X POST -H “Content-Type: application\/json” -d “{\\”firstName\\”: \\”Carolina\\”, \\”lastName\\”: \\”Gomez\\”, \\”email\\”: \\”c.gomez@tue.nl\\”, \\”password\\”: \\”testpassword\\”}” http:\/\/localhost:8989\/api\/user<\/a><\/p>\n

 <\/p>\n

curl -H “Authorization: Bearer 108cf321-06c1-4d30-bb2c-d7904b87cc6e” -X POST -H “Content-Type: application\/json” -d “{\\”age\\”: \\”25\\”, \\”sex\\”: \\”male\\”, \\”height\\”: \\”5\\”, \\”weight\\”: \\”80\\”, \\”gameDescriptor\\”: \\”valueForGameDescriptor\\”, \\”circle\\”: http:\/\/localhost:8080\/circle\/1\\<\/a>, \\”gameSession\\” : \\”http:\/\/localhost:8080\/gameSession\/1\\”}” http:\/\/localhost:8989\/player<\/a><\/p>\n

 <\/p>\n

POST a PropertyInstance with a reference to Property<\/p>\n

curl -H “Authorization: Bearer 108cf321-06c1-4d30-bb2c-d7904b87cc6e” -X POST -H “Content-Type: application\/json” -d “{\\”value\\”: \\”51\\”, \\”property\\”: \\”http:\/\/localhost:8989\/api\/property\/5\\”}” http:\/\/localhost:8989\/api\/propertyInstance<\/a><\/p>\n

Add the value 51 for property score (which is property 5) in propertyInstance<\/p>\n

Check (test after the execution)<\/p>\n

curl -X GET -H “Authorization: Bearer 108cf321-06c1-4d30-bb2c-d7904b87cc6e” http:\/\/localhost:8989\/api\/property\/5\/propertyInstances<\/a><\/p>\n

Add another value to 32, to see if it really works (regression test)<\/p>\n

curl -H “Authorization: Bearer 108cf321-06c1-4d30-bb2c-d7904b87cc6e” -X POST -H “Content-Type: application\/json” -d “{\\”value\\”: \\”32\\”, \\”property\\”: \\”http:\/\/localhost:8989\/api\/property\/5\\”}” http:\/\/localhost:8989\/api\/propertyInstance<\/a><\/p>\n

curl -X GET -H “Authorization: Bearer 108cf321-06c1-4d30-bb2c-d7904b87cc6e” http:\/\/localhost:8989\/api\/property\/5\/propertyInstances<\/a><\/p>\n

 <\/p>\n

This time it shows both previous values, 51, 51 and newly added (32)<\/p>\n

We have to try update to see, if the old value gets updated or not?<\/p>\n

Some other checks<\/p>\n

curl -X GET -H “Authorization: Bearer 108cf321-06c1-4d30-bb2c-d7904b87cc6e” http:\/\/localhost:8989\/api\/propertyInstance\/19\/property<\/a>\u00a0\u00a0 (for value 32)<\/p>\n

This returns \u201cScore\u201d as a property.<\/p>\n

 <\/p>\n

Update a value<\/h1>\n

curl -H “Authorization: Bearer 108cf321-06c1-4d30-bb2c-d7904b87cc6e” -X PUT -H “Content-Type: application\/json” -d “{\\”value\\”: \\”53\\”, \\”property\\”: \\”http:\/\/localhost:8989\/api\/property\/5\\”}” http:\/\/localhost:8989\/api\/propertyInstance\/17<\/a><\/p>\n

Updates PropertyInstance (17)\u2019s value from 51 to 53.<\/p>\n

Verify: Issue this request<\/p>\n

curl -X GET -H “Authorization: Bearer 108cf321-06c1-4d30-bb2c-d7904b87cc6e” http:\/\/localhost:8989\/api\/property\/5\/propertyInstances<\/a><\/p>\n

It returns all 3 property Instances with values as 51, 32, and 53 which were earlier 51,32, and 51.<\/p>\n

Delete a value<\/h1>\n
    \n
  1. First I\u2019m creating a new PropertyInstance, then I\u2019ll delete it, just to keep the older ones as they are.<\/li>\n
  2. curl -H “Authorization: Bearer 108cf321-06c1-4d30-bb2c-d7904b87cc6e” -X POST -H “Content-Type: application\/json” -d “{\\”value\\”: \\”49\\”, \\”property\\”: \\”http:\/\/localhost:8989\/api\/property\/5\\”}” http:\/\/localhost:8989\/api\/propertyInstance<\/a><\/li>\n<\/ol>\n

    curl -H “Authorization: Bearer 108cf321-06c1-4d30-bb2c-d7904b87cc6e” -X POST -H “Content-Type: application\/json” -d “{\\”value\\”: \\”13\\”, \\”property\\”: \\”http:\/\/localhost:8989\/api\/property\/5\\”}” http:\/\/localhost:8989\/api\/propertyInstance<\/a><\/p>\n

      \n
    1. Check if it is added<\/li>\n<\/ol>\n

      curl -X GET -H “Authorization: Bearer 108cf321-06c1-4d30-bb2c-d7904b87cc6e” http:\/\/localhost:8989\/api\/property\/5\/propertyInstances<\/a><\/p>\n

      yes it got added, new reference is 20<\/p>\n

        \n
      1. Delete it<\/li>\n<\/ol>\n

        curl -H “Authorization: Bearer 108cf321-06c1-4d30-bb2c-d7904b87cc6e” -X DELETE -H “Content-Type: application\/json” -d “{\\”property\\”: \\”http:\/\/localhost:8989\/api\/property\/5\\”}” http:\/\/localhost:8989\/api\/propertyInstance\/20<\/a><\/p>\n

        The above is correct way to delete<\/p>\n

        curl -H “Authorization: Bearer 108cf321-06c1-4d30-bb2c-d7904b87cc6e” -X DELETE -H “Content-Type: application\/json” -d http:\/\/localhost:8989\/api\/propertyInstance\/21<\/a><\/p>\n

        This results in error: curl, no url specified<\/p>\n

          \n
        1. Check if it got deleted or not<\/li>\n<\/ol>\n

          curl -X GET -H “Authorization: Bearer 108cf321-06c1-4d30-bb2c-d7904b87cc6e” http:\/\/localhost:8989\/api\/property\/5\/propertyInstances<\/a><\/p>\n

          It is deleted.<\/p>\n

           <\/p>\n

          Updates and Changes<\/h2>\n

          See the history for details<\/p>\n

           <\/p>\n

          History<\/p>\n

          Friday, Aug 07, 2015. Summary of resources, an example request.<\/p>\n

          Monday, Aug 10, 2015. Insert a GameDescriptor<\/p>\n

          Monday, Aug 10, 2015.<\/p>\n

          Curl requests to get token directly failing. Currently it is achieved through running a script.<\/p>\n

          Creation of resources<\/p>\n

          Retrieving resources<\/p>\n

          Updating resources<\/p>\n

          Deleting resources<\/p>\n

          Regression Tests<\/p>\n

           <\/p>\n

           <\/p>\n","protected":false},"excerpt":{"rendered":"

          API Endpoint http:islab1.ieis.tue.nl:8024\/api   Authentication An access token is necessary to be used in each request.   Summary of resources \/user \/player \/challenge \/gameDescriptor \/property \/propertyType \/propertyInstance \/gameSession \/tag \/dataProvider \/tokenForDataProvider \/rointMapping \/role \/support \/circle \/personalPoint \/participation \/reward \/sponsor \/rightToShowChallenge \/challengeRule \/condition \/operator To perform an operation on any of the above listed resources, you … <\/p>\n

          Continue reading “GameBus API”<\/span><\/a><\/p>\n","protected":false},"author":3,"featured_media":0,"parent":1114,"menu_order":1,"comment_status":"closed","ping_status":"closed","template":"","meta":{"footnotes":""},"categories":[],"tags":[],"class_list":["post-79","page","type-page","status-publish","hentry"],"_links":{"self":[{"href":"https:\/\/blog.gamebus.eu\/index.php\/wp-json\/wp\/v2\/pages\/79","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/blog.gamebus.eu\/index.php\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/blog.gamebus.eu\/index.php\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/blog.gamebus.eu\/index.php\/wp-json\/wp\/v2\/users\/3"}],"replies":[{"embeddable":true,"href":"https:\/\/blog.gamebus.eu\/index.php\/wp-json\/wp\/v2\/comments?post=79"}],"version-history":[{"count":0,"href":"https:\/\/blog.gamebus.eu\/index.php\/wp-json\/wp\/v2\/pages\/79\/revisions"}],"up":[{"embeddable":true,"href":"https:\/\/blog.gamebus.eu\/index.php\/wp-json\/wp\/v2\/pages\/1114"}],"wp:attachment":[{"href":"https:\/\/blog.gamebus.eu\/index.php\/wp-json\/wp\/v2\/media?parent=79"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/blog.gamebus.eu\/index.php\/wp-json\/wp\/v2\/categories?post=79"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/blog.gamebus.eu\/index.php\/wp-json\/wp\/v2\/tags?post=79"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}