Skip to content

Latest commit

 

History

History
72 lines (63 loc) · 2.48 KB

login.md

File metadata and controls

72 lines (63 loc) · 2.48 KB
Raw

Login

Client Login to Blink Account on Blink Servers

POST /api/v5/account/login

Headers

  • Content-Type - application/json

Body

  • email - Account userid/email
  • password - Account password
  • unique_id - (optional) UUID generated and identifying the client. Pass a consistent value here to avoid repeated client verification PIN requests.
  • reauth - (optional) Should be set to true to, if the client is already verified. Otherwise blink keeps sending verification PINs.

Response

  • account.account_id - Account Identifier
  • account.client_id - Client Identifier
  • account.client_verification_required - Client verification required by Blink Servers, see Verify Pin.
  • auth.token - String Authentication token to be passed as TOKEN_AUTH header in future calls
  • account.tier - Tier (see notes below)

Notes

Depending on where your Blink system is registered, the tier info appears necessary to form the localized URL of the REST endpoint for future calls. Current logic seems to be to update the REST endpoint using region.tier data in the response:

  • from https://rest-prod.immedia-semi.com
  • to https://rest-{account.tier}.immedia-semi.com Reports indicate that all regions are not implemented equally, i.e. not all endpoints are available in all regions

Example Request

curl 'https://rest-prod.immedia-semi.com/api/v5/account/login' -X POST  -H 'Content-Type: application/json' -d '{"unique_id": "00000000-0000-0000-0000-000000000000", "password":"aPassword","email":"anEmail"}'

Example Response

200 OK

{
    "account": {
        "account_id": 1234,
        "user_id": 123456,
        "client_id": 1234567,
        "new_account": false,
        "tier": "e002",
        "region": "eu",
        "account_verification_required": false,
        "phone_verification_required": false,
        "client_verification_required": false,
        "verification_channel": "phone"
    },
    "auth": {
        "token": "anAuthTokenString"
    },
    "phone": {
        "number": "+49*******1234",
        "last_4_digits": "1234",
        "country_calling_code": "49",
        "valid": true
    },
    "verification": {
        "email": {
            "required": false
        },
        "phone": {
            "required": true,
            "channel": "sms"
        }
    },
    "lockout_time_remaining": 0,
    "force_password_reset": false,
    "allow_pin_resend_seconds": 60
}