API Reference
Every method of skapi-py 2.4.0. Each one raises SkapiError on failure.
Connection
| method | |
|---|---|
Skapi(project_id, *, storage=None, timeout=120, encryption=None) | connects to one project |
get_connection_info(refresh=False) | project name and settings |
Authentication
| method | |
|---|---|
signup(params, option=None) | creates an account |
resend_signup_confirmation() | sends the confirmation e-mail again |
login(email, password, username=None) | signs in |
verify_mfa(code) | finishes a login that needs an authenticator code |
logout(global_logout=False) | signs out |
get_profile(refresh_token=False) | the signed-in user's profile |
login_with_token(id_token, access_token, refresh_token) | adopts tokens from another sign-in |
update_profile(params) | changes the user's profile |
change_password(current_password, new_password) | changes the password |
forgot_password(email) | sends a password reset code |
reset_password(email, code, new_password) | sets a new password with the code |
verify_email(code=None) | sends or checks an e-mail verification code |
last_verified_email(revert=None) | the last verified e-mail |
disable_account() | disables the user's own account |
recover_account(redirect=False) | sends the recovery e-mail to a disabled account |
open_id_login(token, id) | signs in through an OpenID provider |
anonymous_login() | a temporary account without e-mail or password |
verify_anonymous_session() | checks a restored temporary account still exists |
setup_mfa() / enable_mfa(code) / disable_mfa() / get_mfa_status() | two-step login with an authenticator app |
Database
| method | |
|---|---|
post_record(data, config, files=None) | creates or updates a record |
post_records(items) | many records in few requests |
get_records(query, fetch_options=None) | reads records |
delete_records(query) | deletes records |
get_tables / get_tags / get_indexes / get_unique_id | what the database holds |
upload_files(files, record_id) | attaches files to a record |
get_file(url, config=None) | downloads a file, or makes a link to it |
delete_files(endpoints) | removes files from records |
grant_private_record_access / remove_private_record_access / list_private_record_access / request_private_record_access_key | sharing private records |
Encryption
| method | |
|---|---|
get_encryption_status() | locked, unlocked or disabled |
unlock_encryption(password) / lock_encryption() | opens or forgets the user's keys |
unlock_encryption_with_recovery_code(code, password=None) / regenerate_encryption_recovery_code() | encryption recovery codes (the first one is shown once in get_connection_info()) |
pin_peer_key(user_id, fingerprint) | trusts another user's key for sharing |
is_withheld(value) | tells the placeholder of undecryptable data apart |
Users
| method | |
|---|---|
get_users(params=None, fetch_options=None) | searches the project's users |
subscribe(params) / unsubscribe(params) | subscribes to another user |
block_subscriber(params) / unblock_subscriber(params) | blocks a subscriber |
get_subscriptions(params) | who subscribes to whom |
get_feed(params=None) | records from the users you subscribe to |
subscribe_newsletter(params) / unsubscribe_newsletter(group) | newsletter subscription |
get_newsletters(params=None) / get_newsletter_subscription() | sent newsletters and the user's subscriptions |
send_inquiry(data) | sends a message to the project owner |
Realtime
| method | |
|---|---|
connect_realtime(callback) / close_realtime() | opens or closes the realtime connection |
join_realtime(group) | joins or leaves a group |
post_realtime(message, recipient, notification=None) | sends to a user or to the group |
get_realtime_groups(params=None) / get_realtime_users(params=None) | who is connected where |
API Bridge
| method | |
|---|---|
forward_request(options, form=None, on_stream=None) | calls another API through Skapi, with your client secrets |
forward_request_poll(request_id) / forward_request_stream(request_id) | waits for a queued or streamed answer |
forward_request_finalize(request_id, data) | stores a streamed request's final answer |
forward_request_history(params) | past forwarded requests and their answers |
cancel_forward_request(params) / forward_request_queue_count(params) | queue control |
Tickets
| method | |
|---|---|
consume_ticket(ticket_id, method, data, auth) | calls a ticket |
get_tickets(params=None) | the project's tickets |
get_consumed_tickets(params=None) | the user's own ticket calls |
