journyio-sdk 0.0.1

This is the official Python SDK for journy.io.

journy.io Python SDK

This is the official Python SDK for journy.io.

💾 Installation

You can use the python package manager (pip) to install the SDK:

pip install journyio-sdk

🔌 Getting started

Import

To start, first import the client.

from journyio-sdk import Client, Config

Configuration

To be able to use the journy.io SDK you need to generate an API key. If you don't have one you can create one in journy.io.

If you don't have an account yet, you can create one in journy.io or request a demo first.

Go to your settings, under the Connections-tab, to create and edit API keys. Make sure to give the correct permissions to the API Key.

from journyio-sdk import HttpClientRequests
config = Config("api-key-secret")
http_client = HttpClientRequests() # If wanted, an own implementation of the HttpClient interface can be created
client = Client(http_client, config)

Methods

Get API key details

from journyio-sdk import Success
result = client.get_api_key_details()
if isinstance(result, Success):
    print(result.request_id) # str
    print(result.calls_remaining) # int
    print(result.data) # ApiKeyDetails
    print(result.permissions) # list of strings denoting the permissions

Create or update user

Note: when sending an empty value ("") as value for a property, the property will be deleted.

from journyio-sdk import Properties
properties = Properties()
properties["property1"] = "value1"
result = client.upsert_user("[e-mail]", "userId", properties)
if isinstance(result, Success):
    print(result.request_id) # str
    print(result.calls_remaining) # int
    print(result.data) # None

Create or update account

Note: when sending an empty value ("") as value for a property, the property will be deleted.

properties = Properties()
properties["property1"] = "value1"
properties["property2"] = "" # property2 will be deleted
result = client.upsert_account("accountId", "accountName", properties, ["memberId1", "memberId2"])
if isinstance(result, Success):
    print(result.request_id) # str
    print(result.calls_remaining) # int
    print(result.data) # None

Link web visitor to an app user

You can link a web visitor to a user in your application when you have our snippet installed on your website. The snippet sets a cookie named __journey. If the cookie exists, you can link the web visitor to the user that is currently logged in:

result = client.link("userId", "deviceId")
if isinstance(result, Success):
    print(result.request_id) # str
    print(result.calls_remaining) # int
    print(result.data) # None

To get the cookies you can use:

Flask

@app.route('/...')
def method():
    device_id = request.cookies.get('__journey')
    if device_id:
        ...
    ...

Django

def method(request):
    device_id = request.COOKIES.get('__journey')
    if device_id:
        ...
    ...

Add event

from datetime import datetime
from journyio-sdk import Event, Metadata
metadata = Metadata()
metadata["metadata1"] = "value1"
event = Event() \
            .for_user_in_account("accountName", "userId", "accountId") \
            .happened_at(datetime.now()) \
            .with_metadata(metadata)
result = client.add_event(event)
if isinstance(result, Success):
    print(result.request_id) # str
    print(result.calls_remaining) # int
    print(result.data) # None

Get tracking snippet for a domain

from journyio-sdk import Success
result = client.get_tracking_snippet("www.journy.io")
if isinstance(result, Success):
    print(result.request_id) # str
    print(result.calls_remaining) # int
    print(result.data) # TrackingSnippetResonse
    print(result.domain) # str
    print(result.snippet) # str

Handling errors

Every call will return a Success or Failure object. Success objects refer to the call having succeeded (and optionally containing data). A Failure object refers to the API returning an error. This can be any APIError (too many requests, not found...). Our SDK only throws JournyExceptions, no other exceptions should be called. JournyExceptions are provided with useful messages, which state where the error was made.

from journyio-sdk import JournyException
try:
    result = client.get_tracking_snippet("www.journy.io")
    if isinstance(result, Success):
        print(result.request_id) # str
        print(result.calls_remaining) # int
        print(result.data) # TrackingSnippetResonse
    else:
        print(result.request_id) # str
        print(result.calls_remaining) # int
        print(result.error) # APIError
except JournyException as e:
    print(e.msg) # str with error message

The request ID can be useful when viewing API logs in journy.io.

📬 API Docs

API reference

💯 Tests

To run the tests:

cd tests
pip3 install -r requirements.txt
pytest

❓ Help

We welcome your feedback, ideas and suggestions. We really want to make your life easier, so if we’re falling short or should be doing something different, we want to hear about it.

Please create an issue or contact us via the chat on our website.

🔒 Security

If you discover any security related issues, please email hans at journy io instead of using the issue tracker.