aepctl

README

aepctl

aepctl is a command line tool for the Adobe Experience Platform implementing a part of the REST API.

This is the initial state of this project and no release is available.

Overview

aepctl is a complement to the existing web interface and has been developed for advanced users as well as developers. In combination with activated syntax completion, aepctl accelerates the execution of repeating tasks, prototyping and learning the APIs.

Status of Implementation

At the moment the following APIs are implemented:

• Access Control API
• Offer Decisioning

Planed APIs:

• Catalog Service API

Quick Start

1. Install aepctl
   • macOS

     brew install fuxs/formulae/aepctl
     

   • Windows (requires PowerShell)

     Invoke-WebRequest https://www.bungenstock.de/aepctl/releases/v0.2.0/windows/amd64/aepctl.exe -OutFile aepctl.exe
     

     Add aepctl.exe to your PATH
2. Create an Adobe I/O Project (detailed documentation)
3. Provide a config.yaml file with the following command

   aepctl configure
   

   Paste authentication credentials from the Adobe I/O project (click on Service Account(JWT) of your Adobe I/O project) and select a private key file. (detailed documentation)
4. Test the configuration by getting an access token.

   aepctl get token
   

Installation

macOS

The recommended installation method is homebrew. Visit the website and install it if you haven't already.

Run the following command to install aepctl:

brew install fuxs/formulae/aepctl

zsh completion

The zsh is the default shell since macOS 10.15 Catalina and provides strong completion capabilities. It is recommended to activate completions for aepctl in order to ease the input with complex ids or names.

Windows

PowerShell

Open the PowerShell and follow the instructions:

1. Download the latest pre-release aepctl v0.2.0 or use Invoke-WebRequest:

Invoke-WebRequest https://www.bungenstock.de/aepctl/releases/v0.2.0/windows/amd64/aepctl.exe -OutFile aepctl.exe

1. The validation of the binary is optional (go to step 4 if you want to skip it). Download the SHA256 file or use Invoke-WebRequest:

Invoke-WebRequest https://www.bungenstock.de/aepctl/releases/v0.2.0/windows/amd64/aepctl.exe.sha256 -OutFile aepctl.exe.sha256

1. Check the integrity with the following command. You should get the value True as result.

(Get-FileHash aepctl.exe).Hash -eq (Get-Content aepctl.exe.sha256)

1. Add the aepctl.exe to your PATH

2. Test that everything is working by opening the help.

aepctl --help

License

aepctl is released under the Apache 2.0 license.

Documentation

Overview

Package main consists only of this file

Copyright 2021 Michael Bungenstock

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.