I have developed the Adobe Experience Platform API wrapper on python during the last year. It took me quite some time to develop it and create the documentation around it (mostly on github).
I am still far from finish and I am seeing that it will be hard to maintain without support but one thing I know would help many people is to realize demo on how to use it.
Therefore, the same way that I did for my Launch (now Adobe Data Collection Platform) and Adobe Analytics API 2.0 python modules, I have prepared some videos to show how it works.
Understanding Adobe Experience Platform & aepp overview
Adobe Experience Platform is quite complex and it is important that you understand what this platform is and what it is not. Getting familiar with the terminology and the concept will really help your understanding of the API later on.
I will spend some minutes to give you an overview on what Adobe Experience Platform is about. The aim of the video is not to teach you everything. This video is covering the basics and the concepts.
You can definitely learn more with the official documentation.
We will see more details explanation when we will be covering the different submodules.
This video will also show you how I built the Adobe Experience Platform Python module. If you just want to use the module and know Adobe Experience Platform already, you do not really need to watch this video.
By sharing my approach and the development of the python module, I hope to either inspire to either just help me maintaining or developing this module. I learn many things from people honestly providing transparency in their approach that I had to do the same.
Even though I have coded the module on my own, I would have done that without the help of many people way smarter and knowledgable about this solution, or about python or about anything else that help me.
So here is the thank you paragraph, not too low so that everyone can see the persons that we are always smarter together.
To everyone that helped me – THANK YOU.
Introduction to AEP APIs & aepp
This video shows you some elements that you will need to know before starting to use the Adobe Experience Platform API and the aepp module. Some tips and tricks are also described at the end.
AEP API – Schema management
This video is showing how to use the aepp module with the Schema submodule. Creating a mixin or schema, duplicating a mixin or deleting any of these are easy to do with aepp.
AEP API – Catalog
The catalog part is an important piece of the Adobe Experience Platform. It helps you define dataset to hold data in the data lake and the capability to analyze batch ingestion. We will see different methods I am using and the helper functions that I created for my own usage.
AEP API – Query Service
Query Service is an important service from Adobe Experience Platform. The main use-case is to create new datasets from your queries but we will see how aepp is expanded that for you. Especially, downloading data from AEP is made possible from that module.
AEP API – Flow Service & Data Prep
The Flow Service is something that is a central into data ingestion for AEP. It is pretty complicated so this video is going to be quite long and will not cover all the cases. However, if you understand the concept on how it works, you will be able to automate the setup of ingestion pipeline without login to the UI.
On this video, I will also demonstrate the Data Prep capability. It is a very powerful feature of AEP. It is, at the moment, overlooked as as intermediate steps but it can really bring powers to your ingestion team or fix issue going on the current pipeline, when the sources can be changed to match the XDM Format. We will cover this part in the aepp video.
Finally, we will use the Data Ingestion service to send data to the Adobe Experience Platform data lake, especially using the streamMessage method.
AEP API – Identity Service
One important piece of information for Adobe Experience Platform is the Identity Service. This is what shapes the Platform capability for your 1-to-1 relationship. We will review that in the video below and I will try to explain to you how important that service is for Platform, even though you are not directly interacting with it.
Note: Unfortunately, as this is a personal initiative to give you an overview, I do not have a full-blown Adobe Experience Platform experience cloud setup and this capability is limited for me. Therefore, I am in no position to give you a full example of what this can do at the moment. If the Adobe people responsible to get sandboxes available to me provide additional services, I will then re-upload the video with a full demo.
AEP API – Sandboxes, Dataset service, Access Control
Adobe Experience Platform has some smaller services than the one explained above. In a single video I will try to quickly described some of the API I provide access to. I do not think that these endpoints are critical and developed enough so they deserved their own 15 mn video, so I have gathered them into one.
The services I am talking about are:
- Sandbox management
- Dataset Service
- Access Control
The Sandbox management can be useful as you can change the sandbox connected to your submodule class instance directly if you know which sandbox to connect to (and you have the rights). I am demonstrating that in the video as well.
I hope that all of these videos were helpful to you.
Do not hesitate to leave a comment, I plan to extend this blog post with more videos, when more time and more use-cases to demonstrate.
I am trying to use AEPP for my AEP implementation but I am getting following error while installing aepp package in python 3.6
ZIP does not support timestamps before 1980
and also per Adobe they are not aware of this package is this being used with latest adobe versions ?
Apparently the error on zip is specific to pip installation and not to the library.
I would try to install it on python 3.7 or python 3.8 or 3.9.
At the moment, 3.10 is not supported as some submodules are not supported in the new python langague yet.
The library is not the official AEP python package (there is none) it is just a courtesy of my time to the community.
I am new to AEP and trying to create schema through aepp package. Anyone having any code snippet to create a sample schema using aepp pacjkage?
It is very difficult to create a schema from scratch using the API.
I would recommend to create the template in the UI and then try to scale it via API.
I have an idea on how to develop such possibility but missing fund and time. If you want to participant in this open source project, feel free to reach me.