API client for Livejourney App
Project description
Table of Contents
Getting Started
Prerequisites
In order to login the client you will have to authenticate yourself via your API KEY. If you don't have/lost your api key please contact our tech team at api@livejourney.com in order to generate a new one.
Installation
Install and update using pip:
pip install -U lj-api-client
Usage
The client allows you to build request in a more convinient way thus speed up your integration with the live journey app.
# Init client
from lj_api_client import Client
api_key = '{YOUR API KEY HERE}'
client = Client(api_key)
# Get current user
res = client.users.fetch_list()
# List workspaces
res = client.workspaces.fetch_list()
# Get specific worksapce
workspace_id = '{WORKSPACE_ID}'
res = client.workspaces.fetch_item(workspace_id)
# List workspace cards
workspace_id = '{WORKSPACE_ID}'
res = client.workspaces.cards(workspace_id).fetch_list()
# Get specific card
workspace_id, card_id = '{WORKSPACE_ID}', '{CARD_ID}'
res = client.workspaces.cards(workspace_id).fetch_item(card_id)
# Create new card
workspace_id = '{WORKSPACE_ID}'
# Card data see our API Docs for in depth specification
card_data = {
'name': 'my-new-card',
'unit_name': 'Unit',
'permission': 'public',
'key_mapping': {
'unit_key': '{YOUR UNIT KEY}',
'date_format': '{YOUR DATE FORMAT}',
'event_keys':[
'{YOUR EVENT KEY}',
],
'date_keys':[
'{YOUR DATE KEY}',
],
}
}
res = client.workspaces.cards(workspace_id).create_item(card_data)
# Update card
workspace_id, card_id = '{WORKSPACE_ID}', '{CARD_ID}'
card_new_data = {
'name': 'new-name'
}
res = client.workspaces.cards(workspace_id).update_item(
card_id,
card_new_data
)
# Delete card
workspace_id, card_id = '{WORKSPACE_ID}', '{CARD_ID}'
res = client.workspaces.cards(workspace_id).delete(card_id)
# Get card presigned url
workspace_id, card_id = '{WORKSPACE_ID}', '{CARD_ID}'
params = {'data_type': 'log'}
res = client.workspaces.cards(workspace_id).presigned_url(card_id).fetch_list(params=params)
# Feed card
workspace_id, card_id = '{WORKSPACE_ID}', '{CARD_ID}'
res = client.workspaces.cards(workspace_id).feed(card_id).create_item({})
The client also validate the requests via its higher level API
res = client.get_user()
res = client.get_workspaces()
workspace_id = '{WORKSPACE_ID}'
res = client.get_workspace(workspace_id)
workspace_id = '{WORKSPACE_ID}'
res = client.get_cards(workspace_id)
workspace_id, card_id = '{WORKSPACE_ID}', '{CARD_ID}'
res = client.get_card(workspace_id, card_id)
workspace_id = '{WORKSPACE_ID}'
card_data = {
'name': 'my-new-card3',
'unit_name': 'Unit',
'permission': 'public',
'key_mapping': {
'unit_key': '{YOUR UNIT KEY}',
'date_format': '{YOUR DATE FORMAT}',
'event_keys':[
'{YOUR EVENT KEY}',
],
'date_keys':[
'{YOUR DATE KEY}',
],
}
}
res = client.create_card(workspace_id, card_data)
workspace_id, card_id = '{WORKSPACE_ID}', '{CARD_ID}'
res = client.update_card(workspace_id, card_id, card_new_data)
workspace_id, card_id = '{WORKSPACE_ID}', '{CARD_ID}'
res = client.delete_card(workspace_id, card_id)
workspace_id, card_id = '{WORKSPACE_ID}', '{CARD_ID}'
log_file_path, desc_file_path = '{LOG DATA FILE PATH}', '{DESC DATA FILE PATH}'
res = client.upload_data_to_card(
workspace_id,
card_id,
log_file_path,
desc_file_path=desc_file_path
)
For more examples, please refer to the examples directory
CLI
You can also interact with the API directly from the terminal using our CLI. See the interactive doc ljcli --help
for more infos.
Contact
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file lj-api-client-0.1.1.tar.gz
.
File metadata
- Download URL: lj-api-client-0.1.1.tar.gz
- Upload date:
- Size: 9.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.2.0 CPython/3.10.6 Linux/5.10.102.1-microsoft-standard-WSL2
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | b55f0cc5b2f9d2c4a142620ca451abaac5993c733a6ec0865f54ec3fc015a608 |
|
MD5 | e7b7754c118be0cda613b571a533abd3 |
|
BLAKE2b-256 | 338fb768f64a12e824a051efbaedbe6004501996b9789c2eea5a11034bb3c7f4 |
File details
Details for the file lj_api_client-0.1.1-py3-none-any.whl
.
File metadata
- Download URL: lj_api_client-0.1.1-py3-none-any.whl
- Upload date:
- Size: 10.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.2.0 CPython/3.10.6 Linux/5.10.102.1-microsoft-standard-WSL2
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1bb1e50e66a8ac942ece12eeaa68fb399f5f15d092729d797dbbdf234f7d46d9 |
|
MD5 | 726fee3988123243f4bbdde550800a06 |
|
BLAKE2b-256 | f5a738b5d859c1d83420308747416d73742c59cf9a625ea746400ac14fba3087 |