This is a python wrapper for the Adobe Customer Journey API.
One important element when starting with CJA API is that you need to have your adobe console.io Project containing access to AEP and CJA.
You cannot use the API without having access to both elements.
Documentation is split in different places:
- Core methods to setup
cjapy: main documentation - Methods provided by the CJA class instance: cja documentation
- Workspace class documentation: Workspace class
- RequestCreator class documentation: RequestCreator class
- Project class documentation : Project class
A documentation about the releases information can be found here : cjapy releases
Functionalities that are covered :
- Get Dimensions & Metrics
- Get, Update and Delete Tags & Shares
- Get, Update and Delete Dataview
- Get, Update and Delete Date Ranges
- Get, Update and Delete Filters
- Get Top items for a dimension
- Get, Update and delete projects
- Digest Project Information and analyse them via the
Projectclass - Run a report (by default returning a Workspace instance)
- (BETA) Run a multi dimensional report
A documentation is provided to get started quickly with the CJA API wrapper in python.
You can find it here: get started on cjapy
To install the library with PIP use:
pip install cjapy
or, to get the latest version from github
python -m pip install --upgrade git+<https://github.com/pitchmuc/cjapy.git#egg=cjapy>
A logging capability is present on the module for debugging purposes.
There is a proper documentation in place to understand how you can add the logging messages to your runtime.
Documentation on logging in cjapy
In order to use this API in python, you would need to have those libraries installed :
- pandas
- requests
- json
- PyJWT
- PyJWT[crypto]
- pathlib
- pytest
TBW
You can find information about the CJA API here :