Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revisionBoth sides next revision
protogrid:json_api_authentication [2017-12-08 17:29] – csoprotogrid:json_api_authentication [2017-12-08 17:37] – pgrid_wiki_admin
Line 21: Line 21:
 <code json> <code json>
 { {
- POST /api/v2/authenticate +  POST /api/v2/authenticate 
- Host: your_environment.protogrid.com +  Host: your_environment.protogrid.com 
- user_id: example_user +  user_id: example_user 
- user_secret: example_secret+  user_secret: example_secret
 } }
 </code> </code>
Line 32: Line 32:
 <code jquery> <code jquery>
 $.ajax({ $.ajax({
-    type:'POST', +  type:'POST', 
-    url: 'https://example.protogrid.com/api/v2/authenticate', +  url: 'https://example.protogrid.com/api/v2/authenticate', 
-    contentType: 'application/json; charset=utf-8', +  contentType: 'application/json; charset=utf-8', 
-    dataType: 'json', +  dataType: 'json', 
-    beforeSend: function(xhr){ +  beforeSend: function(xhr){ 
-        xhr.setRequestHeader('user_id','tester@test.com'); +      xhr.setRequestHeader('user_id','tester@test.com'); 
-        xhr.setRequestHeader('user_secret','test_password'); +      xhr.setRequestHeader('user_secret','test_password'); 
-    }+  }
 }); });
 </code> </code>
Line 58: Line 58:
 <code json> <code json>
 { {
- "errors": [], +  "errors": [], 
- "protogrid_environment_version": "1.3.9", +  "protogrid_environment_version": "1.3.9", 
- "result": "Login successful!"+  "result": "Login successful!"
 } }
 </code> </code>
Line 66: Line 66:
 == Unsuccessful Response == == Unsuccessful Response ==
 Example response of unsuccessful authentication: Example response of unsuccessful authentication:
-<code json>+<code javascript>
 { {
- “errors”: [ +  “errors”: [ 
- { +    { 
- “code”: 401, +      “code”: 401, 
- “message”: “Your login wasn’t recognized. Please check your e-mail +      “message”: “Your login wasn’t recognized. Please check your e-mail 
- address and password.” +      address and password.” 
- } +    } 
- ],  +  ],  
- "protogrid_environment_version": "1.3.9", +  "protogrid_environment_version": "1.3.9", 
- “result”: {}+  “result”: {}
 } }
 </code> </code>
Line 89: Line 89:
 <code jquery> <code jquery>
 $jq.ajax({ $jq.ajax({
-        type: 'GET', +  type: 'GET', 
-        url: 'https://example.protogrid.com/api/v2/apps', +  url: 'https://example.protogrid.com/api/v2/apps', 
-        contentType: 'application/json; charset=utf-8', +  contentType: 'application/json; charset=utf-8', 
-        dataType: 'json', +  dataType: 'json', 
-        success: function(data) { +  success: function(data) { 
-                console.log(data); +          console.log(data); 
-        }, +  }, 
-        error: function(data) { console.log(data); }+  error: function(data) { console.log(data); }
 }); });
 </code> </code>
Line 104: Line 104:
 Example Python request: Example Python request:
 <code python> <code python>
-The cookie variable was set above in the authenticate example.+# The cookie variable was set above in the authenticate example.
 url = "https://example.protogrid.com/api/v2/apps" url = "https://example.protogrid.com/api/v2/apps"
 req = requests.get(url, cookies=cookie) req = requests.get(url, cookies=cookie)

Trace:

Print/export