User¶

{ "success": true }

$ curl -X POST 'https://api.navixy.com/v2/fsm/user/auth' \
-H 'Content-Type: application/json' \ 
-d '{ "login": "test@email.com", "password": "password123456" }'

{
    "success": true,
    "hash": <string> // session hash
}

$ curl -X POST 'https://api.navixy.com/v2/fsm/user/get_info' \
-H 'Content-Type: application/json' \ 
-d '{ "hash": "a6aa75587e5c59c32d347da438505fc3" }'

{
    "success": true,
    "paas_id": 7,
    "paas_settings": ${pass_settings},
    "user_info": {
        "id": 43568,                     // user id
        "login": "demo@navixy.com",      // user's login (in most cases it's an email address)
        "title": "John Smith",           // user first and last name or organization title
        "phone": "79123456789",          // user phone (if not empty)
        "creation_date": "2016-05-20 01:10:34", // user registration date/time
        "balance": 74.31,                // user balance, max. 2 digits after dot. For subusers, this field should be ignored
        "bonus": 0,                      // user bonus, max. 2 digits after dot. For subusers, this field should be ignored
        "locale": "en_US",               // user locale, for example "en_EN"
        "demo": true,                    // true if this is a demo user, false otherwise
        "verified" : true,               // true if user email already verified
        "legal_type" : "individual",     // string. "individual", "legal_entity" or "sole_trader"
        "default_geocoder": "google",    // user's default geocoder ("google", "yandex", "progorod", "osm", or "locationiq")
        "route_provider": "google",      // user's route provider ("progorod", "google" or "osrm")
        "time_zone": "America/New_York", // user timezone name
        "measurement_system" : "metric", // user's measurement system ("metric", "imperial" or "us")
        "tin": "2345678239",             // Taxpayer identification number aka "VATIN" or "INN"
        "iec": ${string},                // Industrial Enterprises Classifier aka "KPP". Used in Russia for legal entities. Optional.
        // postal address
        "post_country": "USA",           // country
        "post_region": "NY",             // region part of post address (oblast, state, etc.)
        "post_index": "10120",           // post index or ZIP code
        "post_city": "New York",         // city part of post address
        "post_street_address": "1556 Broadway, suite 416" // tail part of post address
        // legal (juridical) address
        "registered_country": "USA",           // country
        "registered_region": "NY",             // region part of post address (oblast, state, etc.)
        "registered_index": "10120",           // post index or ZIP code
        "registered_city": "New York",         // city part of post address
        "registered_street_address": "1556 Broadway, suite 416" // tail part of post address
        "first_name": "John",
        "middle_name": "Walker",
        "last_name": "Smith",
        "legal_name": "QWER Inc." // juridical name (optional)
    },
    "master": { // returned only if current user is sub-user. All fields have same meaning as in "user_info", but for master user's account
    "id": 1234, // same as in "user_info"
    "demo": false, // same as in "user_info"
    "legal_type": "individual", // same as in "user_info"
    "first_name": "David", // same as in "user_info"
    "middle_name": "Middle", // same as in "user_info"
    "last_name": "Blane", // same as in "user_info"
    "legal_name": "Blah LLC", // same as in "user_info"
    "title": "David Blane", // same as in "user_info"
        "balance": 0.0, // master user balance, max. 2 digits after dot. Only returned if subuser has "payment_create" right
        "bonus": 89.78, // master user bonus, max. 2 digits after dot. Only returned if subuser has "payment_create" right
    },
    "tariff_restrictions": ${tariff_restrictions},
    "premium_gis": true,
    "features": ["branding_web"],
    "privileges": { // only returned for subusers. Describes effective subuser privileges
        "rights": [
            "tag_update"
        ]
    }
}

$ curl -X POST 'https://api.navixy.com/v2/fsm/user/get_tariff_restrictions' \
-H 'Content-Type: application/json' \ 
-d '{ "hash": "a6aa75587e5c59c32d347da438505fc3" }'

{
    "success": true,
    "value": ${tariff_restrictions}
}

{
    "allowed_maps": [${map_name}, ...] // [string]. list of allowed maps, e.g. ["roadmap","osm"]
}

$ curl -X POST 'https://api.navixy.com/v2/fsm/user/logout' \
-H 'Content-Type: application/json' \ 
-d '{ "hash": "a6aa75587e5c59c32d347da438505fc3" }'

{ "success": true }

$ curl -X POST 'https://api.navixy.com/v2/fsm/user/logout' \
-H 'Content-Type: application/json' \ 
-d '{ "login": "users_login" }'

{ "success": true }