Repository navigation
API
Alexander edited this page Apr 2, 2018
·
34 revisions
let req = resp = {
id: 0123, // monotonic integer
action: 'INIT' | 'AUTH' | 'GET' | 'SET' | 'UPDATE',
// status: undefined | 'error_atom'
error: undefined | 'error_atom',
}let resp = {
id: 0123, // monotonic integer,
action: 'INIT' | 'AUTH' | '{etc}',
// status: 'database_not_responded' // error atom
error: 'database_not_responded'
}let req = {
id: 5555, // monotonic integer
action: 'INIT',
session_id: undefined | '636ce6bd-07cb-4d66-84eb-f8e3102ae24a' // UUID-v4 from document.localStorage
}
let resp = {
id: 5555, // same as req
action: 'INIT',
session_id: 'f8ffeaca-15ce-442c-9ad0-a859f1acd6c0', // already new UUID-v4 SID with updated expiration time
expires_in: 172800, // 2 days in seconds, parameter for auto renew session ID via JS
// PROPOSAL: full timestamp instead of timing in seconds for better coverage
user_id: undefined | 12345 // provides integer ID if the user has been already logged in
}
// update document.localStorage session_id field
// update telegram auth button start parameterlet req = '/start {session_id}'
let resp = {
id: 8888 // monotonic integer
action: 'AUTH',
user_id: 12345
}let req = {
id: 4444, // monotonic integer
action: 'FETCH',
type: 'USER',
target: 1, // user ID
meta: any, // user field (optional)
content_id: 'user_attr', // DOM unique tag for the data rendering,
data: any // Optional, ex. for UPDATE type
}
let resp = {
id: 4444, // same as req
action: 'FETCH',
type: 'USER',
target: 1,
meta: any, // same as req
content_id: 'user_attr', // same as req
data: {} // object
}let resp = {
id: 4444,
action: 'UPDATE',
type: 'USER',
target: 1,
meta: undefined,
content_id: 'user_attr',
data: {} // object
}let req = {
id: 9876,
action: 'FETCH',
type: 'USER_COUNT',
channel: '@sosireakt',
meta: undefined
}
let resp = {
id: 9876,
action: 'FETCH',
type: 'USER_COUNT',
channel: '@sosireakt',
meta: undefined,
data: 45664 // Count
}