Web Login

INTRODUCTION

Allows the user or 3rd party apps to login and capture a session id.

OVERVIEW

3rd party apps that connect to this service have to:

  • Sign-up with an email address and password (and not via Social Media)
  • Enable API connections

The session id changes on every login and expires after 8 hours (480 minutes)

PROPERTIES

  • REQUEST:
    • timeOffSet –¬†adjustment to the browsers’ date and time
    • portalID – program group
    • portID – the portal type
    • subsID – subscribers’ database id
    • userID – registered email address
    • userPW – users’ password
    • userCap – captcha value as entered by the user
    • sessCap – session captcha id generated by the server
  • RESPONSE:
    • subsIDPortalCount – returns the number of portals attached to user when the subsID and the portalID is included on the request.
    • intGID – ikonomikal id
    • userID -registered email address
    • sessID – returns the session id
    • userName – user name
    • dteFmt – date format
    • dteSpFmt – date separator format
    • tmeFmt – time format
    • tmeSpFmt – time separator format
    • serverTimeOffSet – the servers’ time offset
    • clientTimeZone – users’ default timezone
    • isSMWithConnect – returns if the login is from a social media account
    • smLoginType – social media login type
    • rspChr
      • rspID – response id (a zero(0) response is a successful response)
      • rspMsg – error message
      • rspChr – error message parameters

ENDPOINT

https://sc-api.ikonomikal.com/bcss_wbcl_wa_sc/api/O1_getSCSessWBLogVer

HTTP VERB

POST

HEADERS

Content-Type: application/json

REQUEST

{"timeOffSet":0,"portalID":"","portID":0,"subsID":"","userID":"","userPW":"","userCap":"","sessCap":""}

RESPONSE

{"subsIDPortalCount": 0,"intGID": "","userID": "","sessID": "","userName": "","dteFmt": 1,"dteSpFmt": 1,"serverTimeOffSet": 0,"clientTimeZone": 0,"isSMWithConnect": 0,"smLoginType": 0,"rspPrc": {"rspID": 0,"rspMsg": "","rspChr": []}}


EXAMPLE

REQUEST:

{"timeOffSet":-180,"portalID":"","portID":0,"subsID":"","userID":"ikotestmail@yahoo.com","userPW":"-----","userCap":"","sessCap":""}

RESPONSE:

{"subsIDPortalCount": 0,"intGID": "4350AABE-9008-4E5F-9121-8471DD6868C6","userID": "ikotestmail@yahoo.com","sessID": "50F235E2-AECF-423A-8E23-8545B9741B71","userName": "iKonomikal Tester","dteFmt": 1,"dteSpFmt": 1,"serverTimeOffSet": 0,"clientTimeZone": 0,"isSMWithConnect": 0,"smLoginType": 0,"rspPrc": {"rspID": 0,"rspMsg": "","rspChr": []}}