Documentation

Authentication

Learn how to authenticate with Akeneo PIM and secure your exports.

Creating Your SyncPim Account

We use Clerk for secure authentication with multiple sign-in methods.

📧Email + Password

Traditional email-based account

🔵Google OAuth

Sign in with Google

🏢SSO (Enterprise)

Single sign-on for teams

1
Visit & Sign Up

Go to akeneo-exporter.com → Click Get Started

2
Choose Auth Method

Select Email, Google, or SSO and complete verification

3
Access Dashboard

Redirected to dashboard → Create your first configuration

Akeneo PIM API Credentials

Akeneo uses OAuth 2.0 authentication. Create credentials in System → API connections with "Password" flow type.

1

Create API Connection

1

Log in to your Akeneo PIM → System → API connections

2

Click Create → Label: "Akeneo Exporter"

3

Flow type: "Password" → Select a technical user

4

Note the Client ID and Client Secret

2

Required Permissions

Read products
Read product models
Read categories
Read attributes
Read reference entities
💡Write access not required

Using Your Credentials

Enter credentials in Dashboard → Configurations → New Configuration.

1
Akeneo URL

https://your-company.cloud.akeneo.com

2
Client ID & Secret

From your API connection

3
Username & Password

API user credentials

4
Test Connection

Green checkmark = ready!

Example configuration
{
  "akeneo": {
    "url": "https://your-akeneo.cloud",
    "clientId": "1_xxxxxxxxxxxxx",
    "clientSecret": "yyyyyyyyyyyyyyyy",
    "username": "api_user",
    "password": "secure_password"
  }
}

🔐 Encrypted with AES-256-GCM before storage.

Database Authentication

Connect to your database with read/write access. SSL/TLS strongly recommended.

🍃

MongoDB

bash
mongodb://user:pass@host:27017/db
  ?authSource=admin&ssl=true
readWrite role
insert / update
createCollection
🐘

PostgreSQL

bash
postgresql://user:pass@host:5432/db
  ?sslmode=require
CONNECT privilege
INSERT / UPDATE
CREATE TABLE

💡 Always use Test Connection before saving to verify connectivity and permissions.

Security Best Practices

🔐AES-256-GCM Encryption

All credentials encrypted before storage.

👤Least Privilege

Read-only for Akeneo, readWrite for database.

🔒SSL/TLS Connections

Always encrypt data in transit.

🔄Rotate Every 90 Days

Regular credential rotation.

📊Monitor API Logs

Track usage in Akeneo logs.

🔑Strong Passwords

Unique, complex passwords only.

⚠️ Never commit credentials to version control or share via email. Use environment variables or secrets management.