Développeurs

Référence de l’API Conphora

Lisez depuis vos propres systèmes le statut de conformité, le Risk Score et le pack client de vos produits, envoyez de nouveaux produits dans Conphora et récupérez tout votre catalogue sous forme de flux en direct. L’API est conçue pour être appelée depuis un serveur.

Créer une clé API
URL de base
https://documents.conphora.com
Version actuelle
/api/v1 · meta.apiVersion: "2026-09-10"

L’API de lecture (GET /api/v1/products, GET /api/v1/fields) et le flux produits sont disponibles dans toutes les formules. POST /api/v1/intake nécessite la formule en libre-service et une clé read_write.

Pour commencer

Authentification

Chaque requête à l’API porte une clé API. Une clé appartient à une organisation et ne peut lire que les profils de conformité de cette organisation.

Créer une clé

  1. Sur la plateforme, ouvrez Paramètres → Clés API et créez une clé. Donnez-lui un nom pour votre propre repérage.
  2. Choisissez la portée : laissez la case « Autoriser cette clé à envoyer des produits dans la Boîte de réception » décochée pour une clé en lecture seule, cochez-la pour une clé read_write.
  3. Si votre organisation compte au moins deux profils de conformité, vous pouvez lier la clé à l’un d’eux.
  4. Copiez la clé. Elle commence par cfa_live_ et ne s’affiche qu’une seule fois : Conphora ne peut pas la réafficher. Si vous la perdez, révoquez-la et créez-en une nouvelle.

La liste des clés indique, pour chaque clé, ses premiers caractères, son nom, sa portée, son profil lié, sa date de création et sa dernière utilisation. La révocation d’une clé prend effet immédiatement ; la clé reçoit alors 401 revoked_api_key. Vous pouvez renommer une clé, mais pas modifier sa portée ni sa liaison, créez plutôt une nouvelle clé.

Envoyer la clé

Envoyez la clé dans l’en-tête x-api-key. Authorization: Bearer <key> est également accepté ; lorsque les deux sont envoyés, x-api-key l’emporte.

Exemple : données fictivesHTTP
x-api-key: cfa_live_…
# or
Authorization: Bearer cfa_live_…

Utilisez la clé uniquement sur votre serveur, jamais dans le JavaScript d’une boutique en ligne ou d’un navigateur. Les appels directs à l’API depuis un navigateur ne sont pas pris en charge.

Portées

Portées
Portée de la cléSignification
readGET /api/v1/products et GET /api/v1/fields. C’est la valeur par défaut.
read_writeTout ce que read peut appeler, plus POST /api/v1/intake.

La portée est fixée à la création de la clé.

Liaison à un profil

  • Une clé liée à un profil ne peut désigner que ce profil. Tout autre profileId renvoie 403 profile_not_allowed.
  • Une clé non liée peut désigner n’importe quel profil de son organisation. Un profil qui n’existe pas, ou qui appartient à une autre organisation, renvoie 404 profile_not_found.

Où trouver l’identifiant de votre profil

Chaque point d’accès exige un profileId : l’identifiant d’un profil de conformité sur la plateforme. Paramètres → Clés API affiche un exemple de requête qui le contient déjà. GET /api/v1/fields renvoie l’identifiant et le nom du profil, ce qui vous permet de vérifier que vous avez le bon.

GET/api/v1/products

Rechercher des produits

Recherchez de 1 à 100 produits par votre propre identifiant, par nom ou par code-barres, et obtenez leur statut de conformité, leur Risk Score, la prochaine action et leur pack client. Il n’existe aucun point d’accès qui liste un catalogue entier ; utilisez pour cela le flux produits.

Portée de la clé: readFormule: toutes les formules

Paramètres de requête

ParamètreTypeObligatoireValeur par défautSignification
profileIdstringouiLe profil de conformité dans lequel chercher. Il doit appartenir à l’organisation de la clé et correspondre à la liaison de la clé si celle-ci est liée.
valuesstring (comma-separated or repeated)ouiLes valeurs à rechercher. values=A,B,C et values=A&values=B fonctionnent tous deux ; utilisez la forme répétée lorsqu’une valeur contient une virgule. Les valeurs sont nettoyées des espaces, les valeurs vides sont ignorées et les doublons exacts sont supprimés puis comptés. 100 au maximum après suppression des doublons.
valuestringaliasAccepté comme alias de values et fusionné avec lui.
fieldidentifier | name | gtinnonidentifierCe que représentent les valeurs : identifier = votre propre identifiant de produit (la colonne que votre import a associée à l’identifiant, par exemple « SKU »), name = le nom du produit, gtin = un code-barres EAN / UPC / GTIN. Insensible à la casse. Aucun autre nom n’est accepté.
includeArchivedtruenonfalseInclure les produits archivés. Sans ce paramètre, les correspondances archivées sont exclues et un résultat not_found indique archivedMatchCount lorsque des produits archivés correspondaient.

Comment fonctionne la correspondance

  • identifier : d’abord une correspondance exacte, puis des variantes tolérantes, les zéros initiaux des valeurs entièrement numériques sont ignorés (« 0012345 » trouve « 12345 »), puis la ponctuation, puis la casse. Les valeurs entièrement numériques de plus de 15 chiffres sont refusées avec value_precision_unsupported. Une valeur peut compter 512 caractères au maximum.
  • gtin : le code-barres est normalisé au format GS1 à 14 chiffres et comparé exactement. Les formats à 8, 12, 13 et 14 chiffres et les séparateurs sont acceptés ; tout autre format donne not_a_gtin.
  • name : d’abord le nom exact, puis une recherche qui ignore la casse et la ponctuation.
  • Lorsque plusieurs produits correspondent, le résultat est ambiguous avec les candidats. L’API ne devine jamais : relancez la recherche avec l’identifier d’un candidat.
  • Avec field=identifier, une valeur qui n’est pas encore un produit mais qui attend dans la Boîte de réception revient avec le statut staged.

Réponse

La réponse contient results (un par valeur distincte, dans l’ordre de la requête), summary et meta. Une valeur introuvable, ambiguë ou invalide n’est pas une erreur HTTP : elle revient dans le 200 sous la forme de son propre résultat.

Résultats par statut

statusChampSignification
foundvalue, matchedVia, productExactement un produit correspond.
not_foundvalue, archivedMatchCount (only when > 0)Aucune correspondance.
stagedvalue, inbox { status: pending | dismissed, receivedAt }En attente dans la Boîte de réception, pas encore suivi : il n’y a donc pas encore d’état de conformité.
ambiguousvalue, matches [{ id, identifier, name }]Plusieurs produits correspondent.
ambiguous_truncatedvalueLa recherche a atteint sa limite de candidats. Affinez la valeur ou utilisez identifier. Impossible avec field=gtin.
invalid_valuevalue, reason: empty_value | value_too_long | value_precision_unsupported | not_a_gtinLa valeur ne peut pas être recherchée.

matchedVia indique comment un produit found a été trouvé : identifier_exact, identifier_numeric_zerostrip, identifier_numeric_roundtrip, identifier_alnum, identifier_normalized, name_exact, name_normalized, gtin_exact, gtin_canonical.

summary compte les résultats : requested, found, notFound, staged, ambiguous, invalid, duplicatesDropped. ambiguous inclut ambiguous_truncated ; duplicatesDropped n’apparaît que lorsque des valeurs ont été supprimées.

meta contient resolvedField (le champ utilisé), identifierField (le nom que votre import donne à la colonne d’identifiant, à titre d’information) et apiVersion.

L’objet produit

Chaque clé est toujours présente, dans cet ordre. Les colonnes de votre tableur importé ne sont jamais renvoyées par l’API.

ChampTypeSignification
idstringL’identifiant de produit stable de Conphora. Ce n’est pas une valeur de recherche.
profileIdstringLe profil de conformité.
identifierstringVotre identifiant de produit.
identifierFieldstring | nullLe nom que votre import donne à la colonne d’identifiant.
gtinstring | nullLe code-barres sur 14 chiffres, complété par des zéros ; null lorsque l’import ne contenait pas de code-barres valide.
namestringLe nom du produit.
imageUrlstring | nullL’URL de l’image issue de votre import.
hsCodestring | nullLe code SH / code de marchandise.
archivedbooleanTrue pour un produit archivé.
status.classificationin_progress | awaiting_clarification | completed | failed | nullOù en est la classification ; null lorsqu’elle n’a pas commencé.
status.compliancenot_checked | compliant | requires_complianceL’état de conformité. Jamais null : not_checked lorsque le produit n’a jamais été évalué.
compliance.lastCheckedAtnumber (ms epoch) | nullDate de la dernière évaluation du produit.
compliance.summary.matchedCountnumberNombre d’exigences applicables.
compliance.summary.fulfilledCountnumberNombre d’entre elles qui sont satisfaites.
compliance.progress{ compliance, attributes, documents }: { filled, total }Paires renseignées / total pour les exigences, les données produit et les documents ; {0, 0} lorsqu’il n’y en a aucune.
compliance.matchedRegulations[]{ id, shortName, fullTitle | null, eurLexUrl | null }Les règlements applicables.
compliance.missingRequirements[]{ key, kind, regulation, requirementId, domain | null, label, deferred }Les exigences ouvertes. kind vaut doc, attr, symbol ou checkpoint. deferred = marqué « Je n’ai pas encore cette donnée » ; elle compte toujours comme manquante.
riskScoreinteger 0–100 | nullLe Risk Score de Conphora : une priorité, pas un verdict. Null tant que le produit n’est pas évalué.
riskBandlow | watch | high | critical | nullLe niveau du score. Null lorsqu’il n’y a pas de score.
nextActionobject | nullLa prochaine chose à faire. Null lorsqu’il n’y a pas de score ou rien à faire.
nextAction.kindstring (see the list below)Ce qu’il faut faire.
nextAction.whoyou | supplierÀ qui revient la prochaine étape.
nextAction.hrefstring (relative platform path)Un chemin relatif sur la plateforme qui ouvre l’action. Ouvrez-le sur l’hôte de la plateforme.
nextAction.afternumberLe Risk Score une fois cette action accomplie.
customerPackobject | nullLe pack client avec ses dix éléments et leur statut, votre vue de travail, identique à celle de la page produit. Renseigné dans la formule en libre-service ; null dans la vérification gratuite, et null lorsque le profil n’a pas encore de données d’entreprise.
customerPack.readyinteger 0–10Combien des dix éléments sont prêts.
customerPack.total10Toujours 10.
customerPack.itemsobject: item id → ready | missing | waiting | not-neededLe statut de chaque élément, dans l’ordre du pack. not-needed = aucune partie de l’élément ne s’applique au produit.
customerPack.urlstring | nullLe lien complet vers la page publique du pack client du produit : le lien permanent propre au produit (le même que celui de l’export et du flux). null lorsqu’il n’y en a pas, et dans la vérification gratuite.
customerPack.pathstring | nullLe même lien sous forme de chemin, /p/<token>, sur l’hôte des documents.
createdAtnumber (ms epoch)Date de création du produit dans Conphora.
updatedAtnumber (ms epoch)Date de la dernière modification du produit.

Risk Score, niveau et prochaine action

riskScore, riskBand et nextAction sont identiques dans toutes les formules. Le score indique quels produits corriger en premier ; il ne qualifie jamais un produit de conforme ou de non conforme. Une non-conformité connue place le produit en critical, quel que soit le score.

Niveaux de risque
riskBandScoreSignification
low0-24Sous surveillance, rien à faire
watch25-49Une échéance approche
high50-74À corriger ce mois-ci
critical75-100Agir maintenant

nextAction.kind prend l’une des valeurs d’un ensemble fixe : clearNonCompliance, reEvaluate, uploadDocument, confirmRequirement, fillProductData, askSupplier, issueDeclaration, runProcedure, registerProduct, assembleTechnicalFile, renewDocument, reconfirmRuleChange, meetKeyDate, submitReport, chaseSupplier, reviewSupplierAnswer.

Comment fonctionne le Risk Score

Éléments du pack client

Les clés de customerPack.items, dans l’ordre du pack. Chaque statut vaut ready, missing, waiting ou not-needed. identity, contact, declaration, standards-tests, safety-information, instructions, substances, packaging-epr, technical-file, recall-contact.

L’API conserve les dix statuts. La page publique du pack que votre client ouvre présente à votre client deux groupes : identity, contact, declaration, safety-information et instructions d’emblée, comptés comme « n sur 5 prêts pour la mise en rayon » ; standards-tests, substances, packaging-epr et recall-contact sur demande, chacun avec un bouton qui vous le demande ; technical-file ne figure pas sur la page.

Exemple de requête

Exemple : données fictivescurl
curl "https://documents.conphora.com/api/v1/products?profileId=jd7f3k2m9q8x4w1v6t5r0n3b2c&field=identifier&values=NB-1042,NB-2210,NB-9999" \
  -H "x-api-key: cfa_live_…"

Exemple de réponse

Exemple : données fictivesJSON
{
  "results": [
    {
      "value": "NB-1042",
      "status": "found",
      "matchedVia": "identifier_exact",
      "product": {
        "id": "k57bq2x9w3m8r1t6v4c0n5p7ds",
        "profileId": "jd7f3k2m9q8x4w1v6t5r0n3b2c",
        "identifier": "NB-1042",
        "identifierField": "SKU",
        "gtin": "05790000123452",
        "name": "Birch stacking rings, 7 pieces",
        "imageUrl": null,
        "hsCode": "9503.00",
        "archived": false,
        "status": {
          "classification": "completed",
          "compliance": "requires_compliance"
        },
        "compliance": {
          "lastCheckedAt": 1793260800000,
          "summary": {
            "matchedCount": 14,
            "fulfilledCount": 9
          },
          "progress": {
            "compliance": {
              "filled": 9,
              "total": 14
            },
            "attributes": {
              "filled": 6,
              "total": 8
            },
            "documents": {
              "filled": 3,
              "total": 5
            }
          },
          "matchedRegulations": [
            {
              "id": "toy-safety",
              "shortName": "TSR",
              "fullTitle": "Toy Safety Regulation",
              "eurLexUrl": null
            },
            {
              "id": "gpsr",
              "shortName": "GPSR",
              "fullTitle": "General Product Safety Regulation",
              "eurLexUrl": null
            }
          ],
          "missingRequirements": [
            {
              "key": "doc:TSR:eu-declaration-of-conformity",
              "kind": "doc",
              "regulation": "TSR",
              "requirementId": "eu-declaration-of-conformity",
              "domain": "documentation",
              "label": "EU declaration of conformity",
              "deferred": false
            }
          ]
        },
        "riskScore": 58,
        "riskBand": "high",
        "nextAction": {
          "kind": "issueDeclaration",
          "who": "you",
          "href": "/nordbirk/products/k57bq2x9w3m8r1t6v4c0n5p7ds?step=declaration",
          "after": 41
        },
        "customerPack": {
          "ready": 6,
          "total": 10,
          "items": {
            "identity": "ready",
            "contact": "ready",
            "declaration": "missing",
            "standards-tests": "ready",
            "safety-information": "ready",
            "instructions": "waiting",
            "substances": "ready",
            "packaging-epr": "missing",
            "technical-file": "ready",
            "recall-contact": "missing"
          },
          "url": null,
          "path": null
        },
        "createdAt": 1790582400000,
        "updatedAt": 1793260800000
      }
    },
    {
      "value": "NB-2210",
      "status": "staged",
      "inbox": {
        "status": "pending",
        "receivedAt": 1793174400000
      }
    },
    {
      "value": "NB-9999",
      "status": "not_found"
    }
  ],
  "summary": {
    "requested": 3,
    "found": 1,
    "notFound": 1,
    "staged": 1,
    "ambiguous": 0,
    "invalid": 0
  },
  "meta": {
    "resolvedField": "identifier",
    "identifierField": "SKU",
    "apiVersion": "2026-09-10"
  }
}

Erreurs

400 missing_parameter, 400 too_many_values, 400 unknown_field, 400 invalid_profile_id, 401 missing_api_key, 401 invalid_api_key, 401 revoked_api_key, 403 profile_not_allowed, 404 profile_not_found, 413 response_too_large, 429 rate_limited — Erreurs

GET/api/v1/fields

Découvrir les champs

Indique quelles valeurs de `field` la recherche accepte et comment l’import du profil nomme sa colonne d’identifiant. Toute portée de clé ; mêmes règles de profil que ci-dessus.

Portée de la clé: readFormule: toutes les formules

Paramètres de requête

ParamètreTypeObligatoireSignification
profileIdstringouiLe profil de conformité.

Réponse

ChampTypeSignification
profile.idstringL’identifiant du profil.
profile.namestringLe nom du profil.
identifierFieldstring | nullLe nom que le dernier import donne à la colonne d’identifiant.
supportedFieldsstring[]Toujours ["identifier", "name", "gtin"].
meta.apiVersionstringLa version de l’API.

Exemple de requête

Exemple : données fictivescurl
curl "https://documents.conphora.com/api/v1/fields?profileId=jd7f3k2m9q8x4w1v6t5r0n3b2c" \
  -H "x-api-key: cfa_live_…"

Exemple de réponse

Exemple : données fictivesJSON
{
  "profile": {
    "id": "jd7f3k2m9q8x4w1v6t5r0n3b2c",
    "name": "Nordbirk ApS"
  },
  "identifierField": "SKU",
  "supportedFields": [
    "identifier",
    "name",
    "gtin"
  ],
  "meta": {
    "apiVersion": "2026-09-10"
  }
}

Erreurs

400 missing_parameter, 400 invalid_profile_id, 401 missing_api_key, 401 invalid_api_key, 401 revoked_api_key, 403 profile_not_allowed, 404 profile_not_found, 429 rate_limited — Erreurs

POST/api/v1/intake

Envoyer des produits

Envoyez jusqu’à 100 produits par requête dans la Boîte de réception d’un profil. Les nouveaux identifiants attendent dans la Boîte de réception jusqu’à ce qu’une personne de votre équipe les passe en suivi ; un produit dont l’identifiant correspond à un produit existant met ce produit à jour sur place. L’envoi lui-même n’est pas facturé, et renvoyer le même produit ne change rien.

Portée de la clé: read_writeFormule: formule en libre-service

Nécessite une clé de portée read_write (sinon 403 insufficient_scope) et la formule en libre-service (sinon 403 membership_required). Le corps est au format JSON, 1 Mo au maximum.

Corps de la requête

ChampTypeObligatoireSignification
profileIdstringouiLe profil de conformité cible.
productsarray (1–100)ouiLes produits. Un doublon ultérieur d’un uniqueId est ignoré (le premier l’emporte) et compté.
products[].uniqueIdstring | numberouiVotre identifiant de produit, 512 caractères au maximum après suppression des espaces.
products[].namestringouiLe nom du produit (10 000 caractères au maximum).
products[].descriptionstringouiLa description du produit. La classification de Conphora en a besoin.
products[].gtinstring | numbernonLe code-barres. S’il est présent, il doit être un GTIN valide, faute de quoi la ligne est rejetée avec not_a_gtin.
products[].imageUrlstringnonUne URL d’image.
products[].attributesobject of string | number | boolean | nullnonToutes les autres colonnes, sous forme d’objet plat. 300 clés au maximum, de 200 caractères au maximum ; les longues chaînes sont tronquées à 10 000 caractères ; les valeurs imbriquées sont rejetées. Une clé portant le nom d’un champ de premier niveau est écrasée par la valeur de premier niveau.
products[].hintsobject: category → attribute keysnonIndique à la classification quels attributs décrivent quoi. Chaque clé doit exister dans attributes et ne peut figurer que dans une seule catégorie.

Catégories d’indications : productDescription, material, productCategory, packaging, supplierInfo, other.

La Boîte de réception d’un profil contient au maximum 50 000 lignes en attente ; un envoi qui dépasse cette limite reçoit 429 intake_full.

Réponse

results suit l’ordre de la requête, un par produit : uniqueId, status, et intakeId, productId ou errors selon le cas.

Résultats par statut

statusSignification
stagedNouveau : en attente dans la Boîte de réception (intakeId).
refreshedÉtait déjà en attente ; son contenu a été mis à jour.
resurfacedAvait été écarté de la Boîte de réception et revient en attente parce que son contenu a changé.
unchangedDéjà connu, et rien n’a changé.
updatedCorrespondait à un produit actif, qui a été mis à jour (productId).
updated_idleCorrespondait à un produit archivé, qui a été mis à jour sur place et reste archivé.
invalidLa ligne a été rejetée : errors liste des { field, reason }.

Motifs de invalid : required, invalid_type, too_long, not_a_gtin, too_many_attributes, unknown_category, reserved_key, unknown_attribute, assigned_twice.

summary compte les résultats : received, staged, refreshed, unchanged, updated, updatedIdle, archivedSkipped, invalid, duplicatesDropped. received compte les produits après suppression des doublons ; refreshed inclut resurfaced ; archivedSkipped vaut toujours 0 et est conservé pour les anciens clients.

Si une requête échoue en cours de route avec 500 intake_failed, les produits situés avant l’index completed ont été enregistrés et results les liste ; envoyez le reste à nouveau.

Exemple de requête

Exemple : données fictivescurl
curl -X POST "https://documents.conphora.com/api/v1/intake" \
  -H "x-api-key: cfa_live_…" \
  -H "Content-Type: application/json" \
  -d '{
  "profileId": "jd7f3k2m9q8x4w1v6t5r0n3b2c",
  "products": [
    {
      "uniqueId": "NB-3001",
      "name": "Oak pull-along duck",
      "description": "Wooden pull toy for children from 12 months, water-based paint.",
      "gtin": "5790000123469",
      "attributes": {
        "Material": "Oak, water-based paint",
        "Age": "12m+"
      },
      "hints": {
        "material": [
          "Material"
        ]
      }
    },
    {
      "uniqueId": "NB-3002",
      "name": "Felt play mat"
    }
  ]
}'

Exemple de réponse

Exemple : données fictivesJSON
{
  "results": [
    {
      "uniqueId": "NB-3001",
      "status": "staged",
      "intakeId": "m12x7c4v9b2n8q5w3e6r1t0y4u"
    },
    {
      "uniqueId": "NB-3002",
      "status": "invalid",
      "errors": [
        {
          "field": "description",
          "reason": "required"
        }
      ]
    }
  ],
  "summary": {
    "received": 2,
    "staged": 1,
    "refreshed": 0,
    "unchanged": 0,
    "updated": 0,
    "updatedIdle": 0,
    "archivedSkipped": 0,
    "invalid": 1
  },
  "meta": {
    "apiVersion": "2026-09-10"
  }
}

Erreurs

400 missing_parameter, 400 invalid_profile_id, 400 invalid_json, 400 invalid_payload, 400 too_many_products, 401 missing_api_key, 401 invalid_api_key, 401 revoked_api_key, 403 insufficient_scope, 403 profile_not_allowed, 403 membership_required, 404 profile_not_found, 413 payload_too_large, 429 rate_limited, 429 intake_full, 500 intake_failed, 503 rate_limiter_unavailable — Erreurs

GET/feed/{token}

Flux produits

Un flux produits est une URL fixe qui sert toujours les dernières données des produits actifs d’un profil de conformité, au format JSON, CSV ou Excel. Il ne nécessite aucune clé API : le jeton contenu dans l’URL fait office d’identifiant, de sorte que toute personne qui possède l’URL peut lire le flux jusqu’à ce que vous le révoquiez.

Créer et révoquer un lien de flux

  1. Sur la plateforme, ouvrez Tableaux, choisissez « Flux » dans la barre d’outils et créez un lien. Le lien reprend les colonnes visibles dans le tableau à ce moment-là ; vous pourrez modifier ses colonnes et lui donner un libellé plus tard.
  2. Chaque lien dispose de boutons de copie pour CSV, XLSX et JSON.
  3. La révocation d’un lien prend effet immédiatement : la requête suivante reçoit 404.

Les liens de flux sont disponibles dans toutes les formules. Les deux colonnes du pack client ne sont renseignées que dans la formule en libre-service.

Paramètres de requête

ParamètreSignification
formatLe format de sortie : json (par défaut), csv ou xlsx.
sharedNe conserve que les produits qui ont un lien de partage de pack client ouvert portant ce libellé (le nom de votre client, insensible à la casse), et fait pointer l’« URL du pack client » de chaque ligne vers ce partage plutôt que vers le lien permanent du produit. Cela donne à un client un pack à l’échelle du catalogue. Vide avec le contrôle gratuit, qui n’a pas de liens de partage.

Formats

formatSignification
jsonUn tableau d’objets, une clé par nom de colonne. Les colonnes structurées sont des tableaux et des objets, les dates sont au format ISO 8601, les valeurs manquantes sont null.
csvUTF-8 avec une ligne d’en-tête contenant les noms de colonnes, séparées par des virgules. Les cellules à plusieurs valeurs sont jointes par des sauts de ligne.
xlsxUne feuille avec les mêmes cellules que le CSV.

Colonnes

Un lien sert les colonnes choisies pour lui, dans cet ordre : d’abord vos propres colonnes importées sous leur propre nom (identifiant, nom, puis le reste), contrairement à l’API, le flux inclut bien vos données importées, puis les colonnes de Conphora :

ColonneSignification
EAN / GTINLe code-barres à 14 chiffres.
Commodity CodeLe code SH.
Matched RegulationsLes noms courts des règlements applicables.
MarketsLes marchés, avec code et nom du pays.
EN StandardsLes normes recommandées (affichées sur la plateforme sous « Normes recommandées » ; le flux conserve ce nom).
Tested forCe pour quoi vos documents montrent que le produit a été essayé.
AttributesLes données produit : libellé, valeur et unité.
Attributes on ProductLes attributs qui figurent sur le produit.
Attributes on PackagingLes attributs qui figurent sur l’emballage.
Attributes in DocumentationLes attributs qui figurent dans la documentation.
Attributes in Online ListingLes attributs qui figurent dans la fiche en ligne.
Document LinksUne entrée par document : titre, type, domaines de conformité et lien vers le document.
Customer pack« 6 sur 10 prêts » et le statut de chacun des dix éléments (le flux conserve les dix ; la page du pack en présente cinq d’emblée et quatre sur demande) (en JSON : { ready, total, items }). Vide, ou null en JSON, dans la vérification gratuite.
Customer pack URLLe lien vers la page du pack client du produit : le lien permanent du produit, ou le partage du client shared lorsque vous filtrez. Vide dans la vérification gratuite.
CreatedDate de création du produit.
UpdatedDate de la dernière modification du produit.

Le flux ne comporte aucune colonne de statut de conformité, de Risk Score ni de prochaine action ; celles-ci se trouvent dans l’API. Le flux n’a pas de numéro de version : ses noms de colonnes sont son contrat, et les noms de vos colonnes importées suivent vos imports.

Exemple de requête

Exemple : données fictivescurl
curl "https://documents.conphora.com/feed/<your-feed-token>?format=json"

Exemple de réponse

Exemple : données fictivesJSON
[
  {
    "SKU": "NB-1042",
    "Product name": "Birch stacking rings, 7 pieces",
    "Colour": "Natural",
    "EAN / GTIN": "05790000123452",
    "Commodity Code": "9503.00",
    "Matched Regulations": [
      "TSR",
      "GPSR"
    ],
    "Markets": [
      {
        "countryCode": "DK",
        "name": "Denmark"
      },
      {
        "countryCode": "SE",
        "name": "Sweden"
      }
    ],
    "Customer pack": {
      "ready": 6,
      "total": 10,
      "items": {
        "identity": "ready",
        "contact": "ready",
        "declaration": "missing",
        "standards-tests": "ready",
        "safety-information": "ready",
        "instructions": "waiting",
        "substances": "ready",
        "packaging-epr": "missing",
        "technical-file": "ready",
        "recall-contact": "missing"
      }
    },
    "Customer pack URL": null,
    "Created": "2026-09-29T08:00:00.000Z",
    "Updated": "2026-10-29T08:00:00.000Z"
  }
]

Les erreurs du flux sont en texte brut, pas en JSON : 404 lorsque le lien est invalide ou révoqué, 413 lorsque l’export serait trop volumineux (le CSV est le format le plus compact).

Limites de débit

Les lectures et les écritures ont des limites distinctes, comptées chacune par clé API et par organisation (toutes clés confondues). Une requête doit respecter les deux. Les chiffres sont les valeurs d’aujourd’hui, fixées pour arrêter les scripts qui s’emballent, non pour brider un usage normal.

RequêtesCompté parDébitRafale
GET /api/v1/products, GET /api/v1/fieldsclé API600 / minute120
GET /api/v1/products, GET /api/v1/fieldsorganisation3,000 / minute500
POST /api/v1/intakeclé API120 / minute30
POST /api/v1/intakeorganisation600 / minute100

Au-delà de la limite, l’API répond 429 avec l’erreur rate_limited, un champ retryAfterMs et un en-tête Retry-After en secondes (au moins 1). Attendez ce délai avant de réessayer.

Exemple : données fictivesHTTP
HTTP/1.1 429 Too Many Requests
Retry-After: 2

{
  "error": "rate_limited",
  "message": "Too many requests. Slow down and retry.",
  "retryAfterMs": 1800
}

Erreurs

Toute erreur d’un point d’accès `/api/v1` est un JSON de la forme `{ "error": "<code>", "message": "<text>" }`, parfois accompagné de champs supplémentaires, envoyé avec le statut HTTP. Raisonnez sur `error`, jamais sur `message`. Une méthode incorrecte ou un chemin inconnu ne relève pas de ces points d’accès et ne répond pas sous cette forme.

StatuterrorQuandChamps supplémentairesPoints d’accès
400missing_parameterPas de profileId, pas de valeurs, ou pas de products / un tableau vide.tous
400too_many_valuesPlus de 100 valeurs distinctes.maxValuesGET /api/v1/products
400unknown_fieldfield n’est ni identifier, ni name, ni gtin.supportedFieldsGET /api/v1/products
400invalid_profile_idprofileId n’est pas un identifiant bien formé.tous
400invalid_jsonLe corps n’est pas du JSON.POST /api/v1/intake
400invalid_payloadLe corps n’est pas un objet, ou products n’est pas un tableau.POST /api/v1/intake
400too_many_productsPlus de 100 produits.maxProductsPOST /api/v1/intake
401missing_api_keyAucune clé n’a été envoyée.tous
401invalid_api_keyLa clé est inconnue.tous
401revoked_api_keyLa clé a été révoquée.tous
403insufficient_scopeUne clé read a appelé l’envoi de produits.POST /api/v1/intake
403profile_not_allowedLa clé est liée à un autre profil.tous
403membership_requiredL’organisation n’a aucune formule en libre-service active.POST /api/v1/intake
404profile_not_foundLe profil n’existe pas ou appartient à une autre organisation.tous
413response_too_largeLe résultat dépasserait environ 18 Mo. Demandez moins de valeurs.GET /api/v1/products
413payload_too_largeLe corps dépasse 1 Mo.maxBodyBytesPOST /api/v1/intake
429rate_limitedUne limite de débit a été atteinte.retryAfterMs + Retry-After headertous
429intake_fullLa Boîte de réception du profil dépasserait 50 000 lignes en attente.POST /api/v1/intake
500intake_failedLa requête a échoué en cours de route ; les produits situés avant l’index completed ont été enregistrés.completed, resultsPOST /api/v1/intake
503rate_limiter_unavailableLes écritures sont brièvement indisponibles. Réessayez après le délai de l’en-tête Retry-After.Retry-After headerPOST /api/v1/intake

Gestion des versions

  • La version figure dans le chemin (/api/v1) et dans chaque corps de réponse sous meta.apiVersion.
  • Des champs peuvent être ajoutés à tout moment. Écrivez des clients qui ignorent les champs qu’ils ne connaissent pas.
  • Une modification incompatible change la version.

meta.apiVersion: "2026-09-10"

Prêt à vous connecter ?

Créez une clé dans Paramètres → Clés API sur la plateforme et effectuez votre première recherche.

Créer une clé API