Skip to content

Latest commit

 

History

History
101 lines (69 loc) · 4.24 KB

getstarted.md

File metadata and controls

101 lines (69 loc) · 4.24 KB
Raw

Getting Started with the python wrapper for Launch API

On this page, an intro on how to start with the wrapper for Launch.

1. Create an Adobe IO console account

First you should create an Adobe IO account and connect to a Product Profile. You can also create an Adobe IO account and then go to the product Profile in Adobe Admin Console to contect to your Adobe IO account. When you create your Adobe IO account, you need to set a certificate, keep the key nearby because you will need it. You can follow this tutorial

2. Download the library

You can download the library from here and install it directly in your python3X/Lib. or by doing the following command line: pip install launchpy

3. Setup a JSON with your information

Starting with the wrapper, you can import it and create a template for the JSON file that will store your credential to your Adobe IO account.

import launchpy as lp
lp.createConfigFile()

This will create a JSON and you will need to fill it with the information available in your adobe io account.

NOTE: scope in the config file has evolved over time so you can change it. Following this link to see the different scope possible.
You can change the scope attribute for one of these values: "https://ims-na1.adobelogin.com/s/ent_reactor_admin_sdk" or "https://ims-na1.adobelogin.com/s/ent_reactor_sdk" By default, I will test the dev scope if the scope provided fails. So normally nothing you need to do.

NOTE 2: There is a possibility till end of 2024 to use the JWT.
launchpy supports both jwt and oauthV2 authentication.
By default the latest version will try to use the oauthV2.
You can specify the keys generated in the config file by using the auth_type parameter.
Possible values : oauthV2 (default) or jwt

4. Import the configuration file

Once this is done, you can import the configuration file. I would recommend to store the config file and the key in the folder that you are using, however, the element will work if you are using correct path.

lp.importConfigFile('myconfig.json')

5. Instantiate the Admin class & get Company ID to retrieve properties

Once all of these setup steps are completed, you can instantiate the Admin class. The Admin class provides different methods that will return important information going forward. The first method is the getCompanyId(), that will return you the company ID that is attached to your Adobe IO account. You will use the companyId to retrieve the different properties.

import launchpy as lp
lp.importConfigFile('myconfig.json')
admin = lp.Admin()
myCid = admin.getCompanyId()

myProperties = admin.getProperties(myCid)

This will return you a list of properties.

NOTE: The getCompanyId will also save the value inside an attribute (COMPANY_ID) of your instance.
The getProperties will also save the value inside a class attribute (properties).
Therefore, the different information can also be found like this:

## Return the companyId after the usage of the getCompanyId() method
admin.COMPANY_ID

## Return the list of properties after the usage of the getProperties() method
admin.properties

6. Instanciate your Property class

You can use one of your element of the list return to instantiate the work on a property. I usually select the property by name by doing the following :

myProperty = [prop for prop in myProperties if prop['attributes']['name'] == "mypropertyName"][0]
mypropertyName = lp.Property(myProperty) ## here instanciation

7. Use the property methods or Library methods

When you have instanciate the property, you can start using the different methods hosted in the property class. Example:

dataelements = mypropertyName.getDataElements()

You can have a more complete view of the methods on the property documentation

you can also use the libray class to publish the changes, more details on the library class

Global documentation link launchpy starting page.