API REST v1

Documentation Développeur

Intégrez Pimelo à vos outils e-commerce grâce à notre API REST. Gérez vos produits, entités, attributs et médias par programmation.

Démarrage rapide

Prêt en 3 étapes

1

Créer un compte

Inscrivez-vous gratuitement sur Pimelo et accédez à votre tableau de bord.

2

Générer un token API

Rendez-vous dans Paramètres > Tokens API pour créer votre clé d'accès avec les scopes souhaités.

3

Envoyer votre première requête

Utilisez votre token Bearer pour interroger l'API. Testez avec l'endpoint /channels ci-dessous.

# Lister vos canaux de vente curl -X GET https://www.pimelo.app/api/v1/channels \ -H "Authorization: Bearer pim_your_token_here" \ -H "Content-Type: application/json"
Sécurité

Authentification

Toutes les requêtes API nécessitent un token Bearer. Incluez-le dans le header Authorization de chaque requête.

Authorization: Bearer pim_xxxxxxxxxxxxxxxx

Les tokens API commencent par le préfixe pim_ suivi d'une chaîne aléatoire. Chaque token est lié à un utilisateur et à une organisation avec des scopes spécifiques.

Scopes disponibles

Scope Description
products:read Lire les produits et leurs valeurs
products:write Créer et modifier des produits
entities:read Lire les entités et leurs valeurs
entities:write Créer et modifier des entités
settings:read Lire la configuration (canaux, locales)
settings:write Modifier la configuration
media:read Télécharger et consulter les médias
media:write Uploader et gérer les médias
import-export:read Lire les profils et tâches d'import/export
import-export:write Lancer des imports et exports
attributes:read Lire les attributs et jeux d'attributs
attributes:write Créer et modifier les attributs
Concepts

Concepts de l'API

URL de base

Toutes les requêtes API utilisent le même préfixe de base. Les réponses sont au format JSON.

https://www.pimelo.app/api/v1/

Pagination

Les listes de résultats utilisent une pagination par curseur (search_after). Chaque réponse inclut un curseur pour la page suivante.

Filtrage

Les endpoints de recherche acceptent un objet JSON avec des filtres sur les attributs, le statut, le canal et la locale.

Gestion des erreurs

Les erreurs suivent le format RFC 7807 (Problem Details) avec un code HTTP, un type et un message descriptif.

Limites de débit

600 requêtes par minute par token. Les headers X-RateLimit-Limit, X-RateLimit-Remaining et Retry-After sont inclus dans chaque réponse.

API

Ressources API

Explorez les endpoints disponibles pour gérer vos données produit.

MCP Server Disponible

Serveur MCP — Pilotez votre PIM par IA

Connectez Claude, ChatGPT ou tout agent IA à Pimelo via le Model Context Protocol. 14 outils pour rechercher, créer et mettre à jour vos données produit en langage naturel.

Voir la documentation
// Configuration MCP
{
  "mcpServers": {
    "pimelo": {
      "url": "https://…/_mcp"
    }
  }
}
Products
Entities
Entity Types
Attribute Sets
Channels
Locales
Option Sets

Explorer la référence API complète

Documentation interactive avec exemples de requêtes, réponses et possibilité de tester en direct.

Ouvrir la référence API