• You’ve got a PIM developer sandbox. If not, please contact us (https://www.akeneo.com/contact/)
• You’ve installed Docker (20.10.22 or higher)
• You’ve installed Docker Compose V2 plugin (see the official installation tutorial here)

Get the whole Sample-Apps repository and navigate to the PHP Symfony start app folder

git clone [email protected]:akeneo/sample-apps.git
cd samples/start-app/php-symfony

Use ngrok to create a tunnel that allows your App to be accessed using a unique HTTPS URL. You need to create a ngrok account and auth token to preview your App.

ngrok http 8081

We recommend to generate an authtoken too. If you do not, you may need to restart the installation and connection process.

If everything goes well the command will output your public URL for your local App :

1. In your sandbox go to Connect > App store > Create a test App
2. Paste your callback & activation URLs

Name: [My App]
Activate URL: [your-url]/activate
Callback: [your-url]/callback

The App generates the credentials. Copy them for later.

OpenID Connect is a simple identity layer on top of the OAuth 2.0 protocol, implemented in Akeneo PXM Studio to authenticate users. This is an optional feature in Apps, you can also use your own Authentication. To learn more, check the complete documentation.

Next step will let you choose whether you want to use this feature in your app, or not. OpenId related code is clearly identified within the app to allow a fast and easy modification.

Open a terminal at the root of the folder of your App, enter the following command and let us guide you

make install

For information, this command launch scripts locate into common/bin/install in the root folder:

• checkRequirements.sh
• dotEnvFileCreator.sh

1. Back in your sandbox go to Connect > App store

2. You see your App in the section “My App”

3. Click on CONNECT

4. Follow the activation process steps until the end

If everything is good, you should see

It means your App is connected. Well done!

Last but not least, let’s call the PIM API! Simply go here.

You should see

You will find a pre-configured HTTP client here . Feel free to use it for your project.

Voilà! You are ready for developing your App!

If a user updates the access scopes of an already connected app, the access scope update process will require app users to provide consent for the addition of new scopes. You can notify the PIM that the app requires an authorization update using this endpoint:

[your-url]/notify-authorization-update

• Want to get your PIM data to your App? Have a look to our guided tutorials
• Need some tools? Have a look to our dedicated page: we have, with others, a Postman collection that may you during your development.