{"__v":0,"_id":"560526a1f6b86e0d00284abd","category":{"__v":15,"_id":"560262e74f15002100ee4445","pages":["560265953ee4af170004710e","56026815930fe1170074bd5c","56026980930fe1170074bd5f","56026a074f15002100ee444f","56026a794f15002100ee4452","5603e9cd8d58900d0051ea59","56040301e416560d00fa63eb","5604f5ebe266000d00897195","560512f1e266000d008971b6","560515a7e266000d008971ba","56051aafe266000d008971be","56051fcbd5c3900d0003e82c","560521cef6b86e0d00284ab7","560526a1f6b86e0d00284abd","56052d2ef6b86e0d00284ac5"],"project":"55edea207145f717001ac12c","version":"55edea207145f717001ac12f","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-09-23T08:29:27.425Z","from_sync":false,"order":9999,"slug":"api","title":"API"},"editedParams":true,"editedParams2":true,"project":"55edea207145f717001ac12c","user":"55ede9ed1452cd0d009e5e6b","version":{"__v":11,"_id":"55edea207145f717001ac12f","project":"55edea207145f717001ac12c","createdAt":"2015-09-07T19:48:48.670Z","releaseDate":"2015-09-07T19:48:48.670Z","categories":["55edea217145f717001ac130","55ffa8038c0c9d0d00dcac72","55ffbaa48c0c9d0d00dcac88","55ffbd3e8c0c9d0d00dcac8b","55ffbee40e2b090d00863393","55ffc4306932a00d00ba7a85","55ffc66bfeaf310d007dd6c8","55ffc9c2feaf310d007dd6d1","55ffceca0e2b090d008633b2","560111b06811d00d00ceb34e","560262e74f15002100ee4445"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-09-25T10:49:05.902Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"method":"post","results":{"codes":[]},"settings":"","auth":"required","params":[{"_id":"560526a1f6b86e0d00284abf","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"systemToken"},{"_id":"560526a1f6b86e0d00284abe","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"accessToken"}],"url":""},"isReference":false,"order":13,"body":"##Description\nMethod for user single sign-on authentication confirmation.\n\n##URL\n<pre>https://code.rublon.com/api/v3/loginCredentials</pre>\n\n##HTTP Headers\nValid HTTP Headers are described [here](doc:api-http-headers).\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"Note: `X-Rublon-Signature` header should be a keyed hash value using the HMAC method. (Alghoritm is SHA-256, key is your Rublon Secret Key and data is json created from parameters described below.)\"\n}\n[/block]\n##Request parameters\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Param\",\n    \"h-1\": \"Required?\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"systemToken\",\n    \"1-0\": \"accessToken\",\n    \"0-1\": \"`Required`\",\n    \"1-1\": \"`Required`\",\n    \"0-2\": \"The integrated system's unique Id provided by Rublon service in project registration.\",\n    \"1-2\": \"Access Token returned to callbackURL after success beginTransaction request. Token timelife is 120 seconds.\"\n  },\n  \"cols\": 3,\n  \"rows\": 2\n}\n[/block]\n##Responses\n\nThis API call should return standard response for successful HTTP requests (status code 200). \n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"request\",\n    \"h-1\": \"response\",\n    \"0-0\": \"valid\",\n    \"0-1\": \"JSON with `status`='OK', `systemToken`,  `userEmailHashList`, `callbackUrl`, `service`, `deviceId` and `profileId`\",\n    \"1-0\": \"invalid\",\n    \"1-1\": \"JSON with `status`='ERROR' and appropriate `errorMessage`.\"\n  },\n  \"cols\": 2,\n  \"rows\": 2\n}\n[/block]\n### Response format\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"status\\\": \\\"OK\\\",\\n    \\\"result\\\": {\\n        \\\"systemToken\\\": \\\"7BF2551B47784968BD6EDDA97D6557C9\\\",\\n        \\\"callbackUrl\\\": \\\"http://example.com?rublon=callback\\\",\\n        \\\"service\\\": \\\"native\\\",\\n        \\\"deviceId\\\": 123456,\\n        \\\"profileId\\\": 678910,\\n        \\\"emailHashList\\\": [\\n            {\\n                \\\"uid\\\": \\\"885446465\\\",\\n                \\\"hash\\\": \\\"zb0918f57e52671d4ee4f0613fa6abbf01fa3fc38c7e06e43af93c6d57919b02\\\"\\n            },\\n            {\\n                \\\"uid\\\": \\\"622224958\\\",\\n                \\\"hash\\\": \\\"43547b35e76dcdd5a516cc43d3551d2f0f5e232ddbaed04a65bcc4562c5c3d95\\\"\\n            }\\n        ]\\n    }\\n}\",\n      \"language\": \"json\",\n      \"name\": \"200 OK\"\n    },\n    {\n      \"code\": \"{\\n    \\\"status\\\": \\\"ERROR\\\",\\n    \\\"result\\\": {\\n        \\\"errorMessage\\\": \\\"Error: InvalidSignature_RublonAPIException\\\",\\n        \\\"exception\\\": \\\"InvalidSignature_RublonAPIException\\\"\\n    }\\n}\",\n      \"language\": \"json\",\n      \"name\": \"200 InvalidSignature\"\n    }\n  ]\n}\n[/block]\n## Request and response example\n[block:html]\n{\n  \"html\": \"<div class=\\\"try-results\\\"><div class=\\\"try-results-status\\\"><span ng-model=\\\"tryResults.status\\\" class=\\\"httpstatus ng-isolate-scope ng-pristine ng-valid\\\"><span class=\\\"ng-binding httpsuccess\\\" ng-class=\\\"{httpsuccess: status[2], httperror: !status[2]}\\\"><i class=\\\"fa fa-circle\\\"></i> 200 <em class=\\\"ng-binding\\\">OK</em></span></span></div><pre class=\\\"try-results-panel ng-binding\\\">{\\n    \\\"status\\\": \\\"OK\\\",\\n    \\\"result\\\": {\\n        \\\"systemToken\\\": \\\"7BF2551B47784968BD6EDDA97D6557C9\\\",\\n        \\\"callbackUrl\\\": \\\"http://example.com?rublon=callback\\\",\\n        \\\"service\\\": \\\"native\\\",\\n        \\\"deviceId\\\": 123456,\\n        \\\"profileId\\\": 678910,\\n        \\\"emailHashList\\\": [\\n            {\\n                \\\"uid\\\": \\\"885446465\\\",\\n                \\\"hash\\\": \\\"zb0918f57e52671d4ee4f0613fa6abbf01fa3fc38c7e06e43af93c6d57919b02\\\"\\n            },\\n            {\\n                \\\"uid\\\": \\\"622224958\\\",\\n                \\\"hash\\\": \\\"43547b35e76dcdd5a516cc43d3551d2f0f5e232ddbaed04a65bcc4562c5c3d95\\\"\\n            }\\n        ]\\n    }\\n}</pre><div class=\\\"try-results-panel\\\"><table><tbody><tr><th>Method</th><td class=\\\"ng-binding\\\">POST</td></tr><tr><th>Request Headers</th><td> <pre class=\\\"ng-binding\\\">Accept: application/json, text/javascript, */*; q=0.01\\nExpect: 200-OK\\nX-Rublon-Technology: rublon-php-sdk\\nX-Rublon-API-Version: 3.7.1\\nX-Rublon-API-Version-Date: 2015-07-02\\nX-Rublon-Signature: 13f642297ba06763b2485815547e313183284fe4b1cdc803058cfe1801c5e6d8\\naccept-encoding: gzip\\ncontent-type: application/json\\ncontent-length: 167</pre></td></tr><tr><th>URL</th><td class=\\\"ng-binding\\\">https://code.rublon.com/api/v3/loginCredentials</td></tr><tr><th>Request Data</th><td><pre class=\\\"ng-binding\\\">{\\n    \\\"systemToken\\\": \\\"7BF2551B47784968BD6EDDA97D6557C9\\\",\\n    \\\"accessToken\\\": \\\"2xFeMVj5Ukzy7hsVI8oRwmG1YOkTlFETZ9QyosdbuBCV6FShbud1psoLDSl9UiaK7ptrQku1dAgkQIlKyTEHgZdIXI4NRLzyMlKe\\\"\\n}</pre></td></tr><tr><th>Status</th><td> <span ng-model=\\\"tryResults.status\\\" class=\\\"httpstatus ng-isolate-scope ng-pristine ng-valid\\\"><span class=\\\"ng-binding httpsuccess\\\" ng-class=\\\"{httpsuccess: status[2], httperror: !status[2]}\\\"><i class=\\\"fa fa-circle\\\"></i> 200 <em class=\\\"ng-binding\\\">OK</em></span></span></td></tr><tr><th>Response Headers</th><td><pre class=\\\"ng-binding\\\">server: nginx\\ndate: Fri, 25 Sep 2015 10:53:39 GMT\\ncontent-type: application/json\\ntransfer-encoding: chunked\\nconnection: keep-alive\\nset-cookie: rublon_code_session=a%3A5%3A%7Bs%3A10%3A%22session_id%22%3Bs%3A32%3A%22cc06eef8c60a50def772fb5a58ae8c85%22%3Bs%3A10%3A%22ip_address%22%3Bs%3A12%3A%2254.145.2.221%22%3Bs%3A10%3A%22user_agent%22%3Bb%3A0%3Bs%3A13%3A%22last_activity%22%3Bi%3A1443178419%3Bs%3A9%3A%22user_data%22%3Bs%3A0%3A%22%22%3B%7D7127f3883404144551991dc209f5e1d9; path=/; secure; httponly\\nexpires: Sat, 26 Jul 1997 05:00:00 GMT\\nlast-modified: Fri, 25 Sep 2015 10:53:39 GMT\\ncache-control: no-store, no-cache, must-revalidate, post-check=0, pre-check=0\\npragma: no-cache\\nx-rublon-signature: d90edcf45baee0e21c253ac232d5c9e84b4892c1dd1bf6e551d4d16bd3dbd712\\nx-rublon-api-version: 3.7.0\\nx-rublon-api-version-date: 2014-05-20\\nstrict-transport-security: max-age=2592000</pre></td></tr></tbody></table></div></div>\"\n}\n[/block]","excerpt":"","slug":"api-login-credentials","type":"endpoint","title":"loginCredentials"}

postloginCredentials


##Description Method for user single sign-on authentication confirmation. ##URL <pre>https://code.rublon.com/api/v3/loginCredentials</pre> ##HTTP Headers Valid HTTP Headers are described [here](doc:api-http-headers). [block:callout] { "type": "info", "body": "Note: `X-Rublon-Signature` header should be a keyed hash value using the HMAC method. (Alghoritm is SHA-256, key is your Rublon Secret Key and data is json created from parameters described below.)" } [/block] ##Request parameters [block:parameters] { "data": { "h-0": "Param", "h-1": "Required?", "h-2": "Description", "0-0": "systemToken", "1-0": "accessToken", "0-1": "`Required`", "1-1": "`Required`", "0-2": "The integrated system's unique Id provided by Rublon service in project registration.", "1-2": "Access Token returned to callbackURL after success beginTransaction request. Token timelife is 120 seconds." }, "cols": 3, "rows": 2 } [/block] ##Responses This API call should return standard response for successful HTTP requests (status code 200). [block:parameters] { "data": { "h-0": "request", "h-1": "response", "0-0": "valid", "0-1": "JSON with `status`='OK', `systemToken`, `userEmailHashList`, `callbackUrl`, `service`, `deviceId` and `profileId`", "1-0": "invalid", "1-1": "JSON with `status`='ERROR' and appropriate `errorMessage`." }, "cols": 2, "rows": 2 } [/block] ### Response format [block:code] { "codes": [ { "code": "{\n \"status\": \"OK\",\n \"result\": {\n \"systemToken\": \"7BF2551B47784968BD6EDDA97D6557C9\",\n \"callbackUrl\": \"http://example.com?rublon=callback\",\n \"service\": \"native\",\n \"deviceId\": 123456,\n \"profileId\": 678910,\n \"emailHashList\": [\n {\n \"uid\": \"885446465\",\n \"hash\": \"zb0918f57e52671d4ee4f0613fa6abbf01fa3fc38c7e06e43af93c6d57919b02\"\n },\n {\n \"uid\": \"622224958\",\n \"hash\": \"43547b35e76dcdd5a516cc43d3551d2f0f5e232ddbaed04a65bcc4562c5c3d95\"\n }\n ]\n }\n}", "language": "json", "name": "200 OK" }, { "code": "{\n \"status\": \"ERROR\",\n \"result\": {\n \"errorMessage\": \"Error: InvalidSignature_RublonAPIException\",\n \"exception\": \"InvalidSignature_RublonAPIException\"\n }\n}", "language": "json", "name": "200 InvalidSignature" } ] } [/block] ## Request and response example [block:html] { "html": "<div class=\"try-results\"><div class=\"try-results-status\"><span ng-model=\"tryResults.status\" class=\"httpstatus ng-isolate-scope ng-pristine ng-valid\"><span class=\"ng-binding httpsuccess\" ng-class=\"{httpsuccess: status[2], httperror: !status[2]}\"><i class=\"fa fa-circle\"></i> 200 <em class=\"ng-binding\">OK</em></span></span></div><pre class=\"try-results-panel ng-binding\">{\n \"status\": \"OK\",\n \"result\": {\n \"systemToken\": \"7BF2551B47784968BD6EDDA97D6557C9\",\n \"callbackUrl\": \"http://example.com?rublon=callback\",\n \"service\": \"native\",\n \"deviceId\": 123456,\n \"profileId\": 678910,\n \"emailHashList\": [\n {\n \"uid\": \"885446465\",\n \"hash\": \"zb0918f57e52671d4ee4f0613fa6abbf01fa3fc38c7e06e43af93c6d57919b02\"\n },\n {\n \"uid\": \"622224958\",\n \"hash\": \"43547b35e76dcdd5a516cc43d3551d2f0f5e232ddbaed04a65bcc4562c5c3d95\"\n }\n ]\n }\n}</pre><div class=\"try-results-panel\"><table><tbody><tr><th>Method</th><td class=\"ng-binding\">POST</td></tr><tr><th>Request Headers</th><td> <pre class=\"ng-binding\">Accept: application/json, text/javascript, */*; q=0.01\nExpect: 200-OK\nX-Rublon-Technology: rublon-php-sdk\nX-Rublon-API-Version: 3.7.1\nX-Rublon-API-Version-Date: 2015-07-02\nX-Rublon-Signature: 13f642297ba06763b2485815547e313183284fe4b1cdc803058cfe1801c5e6d8\naccept-encoding: gzip\ncontent-type: application/json\ncontent-length: 167</pre></td></tr><tr><th>URL</th><td class=\"ng-binding\">https://code.rublon.com/api/v3/loginCredentials</td></tr><tr><th>Request Data</th><td><pre class=\"ng-binding\">{\n \"systemToken\": \"7BF2551B47784968BD6EDDA97D6557C9\",\n \"accessToken\": \"2xFeMVj5Ukzy7hsVI8oRwmG1YOkTlFETZ9QyosdbuBCV6FShbud1psoLDSl9UiaK7ptrQku1dAgkQIlKyTEHgZdIXI4NRLzyMlKe\"\n}</pre></td></tr><tr><th>Status</th><td> <span ng-model=\"tryResults.status\" class=\"httpstatus ng-isolate-scope ng-pristine ng-valid\"><span class=\"ng-binding httpsuccess\" ng-class=\"{httpsuccess: status[2], httperror: !status[2]}\"><i class=\"fa fa-circle\"></i> 200 <em class=\"ng-binding\">OK</em></span></span></td></tr><tr><th>Response Headers</th><td><pre class=\"ng-binding\">server: nginx\ndate: Fri, 25 Sep 2015 10:53:39 GMT\ncontent-type: application/json\ntransfer-encoding: chunked\nconnection: keep-alive\nset-cookie: rublon_code_session=a%3A5%3A%7Bs%3A10%3A%22session_id%22%3Bs%3A32%3A%22cc06eef8c60a50def772fb5a58ae8c85%22%3Bs%3A10%3A%22ip_address%22%3Bs%3A12%3A%2254.145.2.221%22%3Bs%3A10%3A%22user_agent%22%3Bb%3A0%3Bs%3A13%3A%22last_activity%22%3Bi%3A1443178419%3Bs%3A9%3A%22user_data%22%3Bs%3A0%3A%22%22%3B%7D7127f3883404144551991dc209f5e1d9; path=/; secure; httponly\nexpires: Sat, 26 Jul 1997 05:00:00 GMT\nlast-modified: Fri, 25 Sep 2015 10:53:39 GMT\ncache-control: no-store, no-cache, must-revalidate, post-check=0, pre-check=0\npragma: no-cache\nx-rublon-signature: d90edcf45baee0e21c253ac232d5c9e84b4892c1dd1bf6e551d4d16bd3dbd712\nx-rublon-api-version: 3.7.0\nx-rublon-api-version-date: 2014-05-20\nstrict-transport-security: max-age=2592000</pre></td></tr></tbody></table></div></div>" } [/block]