{"id":876,"date":"2012-03-07T13:37:16","date_gmt":"2012-03-07T12:37:16","guid":{"rendered":"http:\/\/www.lightsoft.se\/?page_id=876"},"modified":"2020-12-20T18:12:58","modified_gmt":"2020-12-20T17:12:58","slug":"faultreporter","status":"publish","type":"page","link":"https:\/\/www.lightsoftai.com\/?page_id=876","title":{"rendered":"FaultReporter (fixa och uppdatera f\u00f6r web)"},"content":{"rendered":"

FaultReporter Rest API<\/span><\/h1>\n

Is a service (Open API) used to be able to report faults to, that occurs at products out at customers that you are not administrating over. Every product need to implement a send logic to send strange exceptions.<\/p>\n

First of you need to register a user. The email and privkey will be your private information, needed to get reports. When creating a user you will recieve a pubKey, this key is used when reporting faults from products, so email and privKey is not used from the products when reporting.<\/p>\n

Unlicense vs License<\/span><\/h3>\n

Unlicense\u00c2  account:<\/strong>
\nFaults older then 15 days<\/strong> will be removed
\nMax new Faults 10\/min<\/strong> will is allowed to be registered<\/p>\n

License account: <\/strong>
\nFaults older then 180 days <\/strong>will be removed
\nMax new Faults 100\/min<\/strong> will is allowed on a registered account<\/p>\n

[highlight] Buying a Licensed account is done by contacting us with a mail, include username, email, private key<\/strong>. Or buying FaultViewer at Google Play [\/highlight]<\/p>\n

 <\/p>\n

FaultViewer on Android<\/h3>\n

Want to view your faults on your Android phone?
\nThen it is possible to view your faults by downloading a free version of FaultViewer.
\nIf you want to buy a license, you will get this by buying the FaultViewer and then create a user will generate a license.<\/p>\n

 <\/p>\n

Restful API<\/h3>\n

Register User<\/h4>\n

Create your user to have your personal user for all projects you will listening on faults for.<\/p>\n

https:\/\/www.lightsoft.se\/FaultReporter\/API\/registerUser
\nContent-Type: application\/json; charset=UTF-8
\nMandatory: name, email, privKey
\nOptional: license
\nPost: {“name”:”User Name”, “email”:”user@email.com”, “privKey”:”user private key”, “license”:”user license”}
\nResp: {“resp”:”OK”, “code”:”200″, “error”:”message if error”}<\/p>\n

 <\/p>\n

Get User<\/h4>\n

Get your user and public Key<\/strong>, that is the key you will have in all projects to report fault from. Public Key is only used in our applications when reporting to this service.<\/p>\n

https:\/\/www.lightsoftai.com\/FaultReporter\/API\/getUser
\nContent-Type: application\/json; charset=UTF-8
\nMandatory: email, privKey
\nPost: {“email”:”user@email.com”, “privKey”:”user private Key”}
\nResp: {“name”:”Your Name”,”pubKey”:”a4f3241-8edd-1d3147f69404″,”projects”:[{“name”:”Project1″,”totalReports”:6},{“name”:”Project2″,”totalReports”:16}]}<\/p>\n

 <\/p>\n

Report<\/h4>\n

https:\/\/www.lightsoftai.com\/FaultReporter\/API\/report
\nContent-Type: application\/json; charset=UTF-8
\nMandatory: pubKey, priority, project
\nOptional: title, data, severity
\nPost: {“pubKey”:”user pubkey”, “priority”:”1″, “project”:”projectname”, “severity”:”4″, “title”:”This is an error”, “data”:”exception”}
\nResp: {“resp”:”Created”, “code”:”201″, “error”:”message if error”}<\/p>\n

 <\/p>\n

Delete Report<\/h4>\n

https:\/\/www.lightsoftai.com\/FaultReporter\/API\/deleteReport
\nContent-Type: application\/json; charset=UTF-8
\nMandatory: privKey, email, id
\nPost: {“privKey”:”user privKey”, “email”:”user email”, “id”:”report id to remove”}
\nResp: {“resp”:”OK”, “code”:”200″, “error”:”message if error”}<\/p>\n

 <\/p>\n

Get Reports<\/h4>\n

https:\/\/www.lightsoftai.com\/FaultReporter\/API\/getReports
\nContent-Type: application\/json; charset=UTF-8
\nMandatory: privkey, project, email
\nOptional: limit (int), paging (int)
\nPost: {“privkey”:”privkey”, “project”:”name of project”, “email”:”useremail”}
\nResp: [{“id”:”35937746-8357-4a64-bd23-fs981a94d154″,”project”:”Your Project”,”title”:”Exception”,”severity”:”5″,”priority”:”3″,”data”:””,”time”:”2012-03-12 14:28:20″},{…}]<\/p>\n

 <\/p>\n

 <\/p>\n

Android code to send a Fault from an application:<\/h3>\n

[sourcecode language=”java”]
\npublic class FaultReporterUtil {<\/p>\n

private static String url_Report = “https:\/\/www.lightsoft.se\/FaultReporter\/API\/report”;<\/p>\n

\/**
\n* Mandatory: pubKey, priority, project, severity Optional: title, data
\n*
\n* @param message
\n*\/
\npublic static void sendFault(final String project, final String title, final int priority, final String severity, final String message) {
\ntry {
\nRunnable updateFeeds = new Runnable() {
\n@Override
\npublic void run() {
\ntry {
\nJSONObject j = new JSONObject();
\nj.put(“pubKey”, “a4f4abf3-4f75-44c3-8edd-1d3147f69404”);
\nj.put(“project”, project);
\nj.put(“priority”, String.valueOf(priority));
\nif (severity != null)
\nj.put(“severity”, String.valueOf(severity));
\nj.put(“title”, title);
\nif (message != null)
\nj.put(“data”, message);<\/p>\n

if (Preferences.DEBUG)
\nLog.d(Preferences.TAG_Restfull, “JSON REQUEST:” + j.toString());<\/p>\n

String re = JSONUtil.doPost(url_Report, j, 3);
\nif (Preferences.DEBUG)
\nLog.d(Preferences.TAG_Restfull, “RESPONSE:” + re.toString());
\n}
\ncatch (Exception e) {
\nLog.e(Preferences.TAG_Restfull, “JSON ERROR:”, e);
\n}
\n}
\n};
\nThread thread = new Thread(null, updateFeeds, “Send FaultReport”);
\nthread.start();<\/p>\n

}
\ncatch (Exception e) {
\nLog.e(Preferences.TAG_Restfull, “JSON ERROR:”, e);
\n}
\n}
\n}
\n[\/sourcecode]
\n[sourcecode language=”java”]
\npublic class JSONUtil {<\/p>\n

\/**
\n* Skicka JSON meddelande och g\u00c3\u00b6r \u00c3\u00a5terf\u00c3\u00b6rs\u00c3\u00b6k om det misslyckas
\n* @param url
\n* @param jsonObj Insert null if not parameters should be sent
\n* @param retry if SocketException
\n* @return
\n* @throws Exception
\n*\/
\npublic static String doPost(String url, JSONObject jsonObj, int retry) throws Exception {
\nException catchEd = null;
\nfor (int i = 0; i < retry; i++){
\nif (Preferences.DEBUG)
\nLog.d(Preferences.TAG_Restfull, “JSON Try\/Retry:” + i + ” : ” + url);
\ntry {
\nreturn doPost(url, jsonObj);
\n}
\ncatch (SocketException soc){
\ncatchEd = soc;
\n}
\n}
\nthrow catchEd;
\n}<\/p>\n

\/**
\n* Do a post to an url with JSON object
\n*
\n* @param url
\n* @param jsonObj
\n* Insert null if not parameters should be sent
\n* @return JSONObject as response from service
\n* @throws ClientProtocolException
\n* @throws IOException
\n*\/
\npublic static String doPost(String url, JSONObject jsonObj) throws Exception {
\nString result = “”;
\ntry {<\/p>\n

DefaultHttpClient httpClient = (DefaultHttpClient) MySSLSocketFactory.getNewHttpClient();
\nHttpParams params = httpClient.getParams();
\nHttpConnectionParams.setConnectionTimeout(params, 10000);
\nHttpConnectionParams.setSoTimeout(params, 10000);
\nConnManagerParams.setTimeout(params, 10000);
\nHttpPost post;
\nif (jsonObj != null) {
\npost = new HttpPost(url + “?”);
\npost.setEntity(new StringEntity(jsonObj.toString(), “UTF-8”));
\n}
\nelse
\npost = new HttpPost(url);<\/p>\n

post.addHeader(“Content-Type”, “application\/json; charset=utf-8”);<\/p>\n

HttpResponse resp = httpClient.execute(post);
\nInputStream is = resp.getEntity().getContent();
\nBufferedReader br = new BufferedReader(new InputStreamReader(is));
\nString line;
\nwhile ((line = br.readLine()) != null)
\nresult += line;
\nbr.close();<\/p>\n

return result;<\/p>\n

}
\ncatch (Exception ex) {
\nthrow ex;
\n}
\n}
\n}
\n[\/sourcecode]<\/p>\n","protected":false},"excerpt":{"rendered":"

FaultReporter Rest API Is a service (Open API) used to be able to report faults to, that occurs at products out at customers that you are not administrating over. Every product need to implement a send logic to send strange exceptions. First of you need to register a user. The email and privkey will be […]<\/p>\n","protected":false},"author":1,"featured_media":0,"parent":0,"menu_order":0,"comment_status":"closed","ping_status":"closed","template":"","meta":{"footnotes":""},"class_list":["post-876","page","type-page","status-publish","hentry"],"_links":{"self":[{"href":"https:\/\/www.lightsoftai.com\/index.php?rest_route=\/wp\/v2\/pages\/876","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.lightsoftai.com\/index.php?rest_route=\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/www.lightsoftai.com\/index.php?rest_route=\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/www.lightsoftai.com\/index.php?rest_route=\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/www.lightsoftai.com\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=876"}],"version-history":[{"count":30,"href":"https:\/\/www.lightsoftai.com\/index.php?rest_route=\/wp\/v2\/pages\/876\/revisions"}],"predecessor-version":[{"id":1702,"href":"https:\/\/www.lightsoftai.com\/index.php?rest_route=\/wp\/v2\/pages\/876\/revisions\/1702"}],"wp:attachment":[{"href":"https:\/\/www.lightsoftai.com\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=876"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}