Authenticatie
Elke API-aanvraag bevat een API-sleutel. Een sleutel hoort bij één organisatie en kan alleen de conformiteitsprofielen van die organisatie lezen.
Een sleutel aanmaken
- Open op het platform Settings → API Keys en maak een sleutel aan. Geef hem een naam voor eigen gebruik.
- Kies het bereik: laat ‘Allow this key to push products into the Inbox’ uitgevinkt voor een alleen-lezen sleutel, vink het aan voor een
read_write-sleutel. - Heeft uw organisatie twee of meer conformiteitsprofielen, dan kunt u de sleutel aan één ervan koppelen.
- Kopieer de sleutel. Hij begint met
cfa_live_en wordt maar één keer getoond: Conphora kan hem niet opnieuw tonen. Raakt u hem kwijt, trek hem dan in en maak een nieuwe aan.
De sleutellijst toont van elke sleutel de eerste tekens, de naam, het bereik, de profielkoppeling, wanneer hij is aangemaakt en wanneer hij voor het laatst is gebruikt. Intrekken van een sleutel gaat direct in; de sleutel krijgt dan 401 revoked_api_key. U kunt een sleutel hernoemen, maar zijn bereik of koppeling niet wijzigen, maak daarvoor een nieuwe sleutel aan.
De sleutel meesturen
Stuur de sleutel mee in de header x-api-key. Authorization: Bearer <key> wordt ook geaccepteerd; als beide worden verstuurd, wint x-api-key.
x-api-key: cfa_live_…
# or
Authorization: Bearer cfa_live_… Gebruik de sleutel alleen op uw server, nooit in JavaScript van een webshop of browser. Browsers die de API rechtstreeks aanroepen worden niet ondersteund.
Bereiken
| Sleutelbereik | Betekenis |
|---|---|
read | GET /api/v1/products en GET /api/v1/fields. De standaardinstelling. |
read_write | Alles wat read kan aanroepen, plus POST /api/v1/intake. |
Het bereik ligt vast zodra de sleutel is aangemaakt.
Profielkoppeling
- Een sleutel die aan een profiel is gekoppeld, mag alleen dat profiel noemen. Elk ander
profileIdkrijgt403 profile_not_allowed. - Een niet-gekoppelde sleutel mag elk profiel van zijn organisatie noemen. Een profiel dat niet bestaat of bij een andere organisatie hoort, krijgt
404 profile_not_found.
Waar u uw profiel-id vindt
Elk endpoint vraagt om een profileId: de id van een conformiteitsprofiel op het platform. Settings → API Keys toont een voorbeeldaanvraag waarin die al staat. GET /api/v1/fields geeft de id en naam van het profiel terug, zodat u kunt controleren of u het juiste hebt.
GET/api/v1/products
Producten opzoeken
Zoek 1 tot 100 producten op via uw eigen identificatiecode, naam of barcode en krijg hun conformiteitsstatus, Risk Score, volgende actie en klantpakket. Er is geen endpoint dat een hele catalogus opsomt; gebruik daarvoor de productfeed.
Sleutelbereik: readAbonnement: elk abonnement
Queryparameters
| Parameter | Type | Verplicht | Standaard | Betekenis |
|---|---|---|---|---|
profileId | string | ja | Het conformiteitsprofiel waarin wordt gezocht. Het moet bij de organisatie van de sleutel horen en, als de sleutel is gekoppeld, overeenkomen met de koppeling. | |
values | string (comma-separated or repeated) | ja | De waarden die worden opgezocht. values=A,B,C en values=A&values=B werken allebei; gebruik de herhaalde vorm als een waarde een komma bevat. Waarden worden getrimd, lege waarden vervallen en exacte dubbelen vervallen en worden geteld. Maximaal 100 nadat dubbelen zijn verwijderd. | |
value | string | alias | Wordt geaccepteerd als alias van values en ermee samengevoegd. | |
field | identifier | name | gtin | nee | identifier | Wat de waarden zijn: identifier = uw eigen productidentificatiecode (de kolom die uw import als identificatiecode heeft toegewezen, zoals ‘SKU’), name = de productnaam, gtin = een EAN-/UPC-/GTIN-barcode. Hoofdletterongevoelig. Andere namen worden niet geaccepteerd. |
includeArchived | true | nee | false | Neem gearchiveerde producten mee. Zonder deze optie blijven gearchiveerde treffers weg en meldt een not_found-resultaat archivedMatchCount als er gearchiveerde producten overeenkwamen. |
Hoe het zoeken werkt
identifier: eerst een exacte overeenkomst, daarna tolerante varianten, voorloopnullen van waarden die alleen uit cijfers bestaan worden genegeerd (‘0012345’ vindt ‘12345’), daarna leestekens, daarna hoofdletters. Waarden van alleen cijfers met meer dan 15 cijfers worden geweigerd alsvalue_precision_unsupported. Een waarde mag maximaal 512 tekens lang zijn.gtin: de barcode wordt genormaliseerd naar de 14-cijferige GS1-vorm en exact vergeleken. 8, 12, 13 en 14 cijfers en scheidingstekens zijn toegestaan; al het andere isnot_a_gtin.name: eerst de exacte naam, daarna een zoekopdracht die hoofdletters en leestekens negeert.- Komt er meer dan één product overeen, dan is het resultaat
ambiguousmet de kandidaten. De API raadt nooit: vraag opnieuw met deidentifiervan een kandidaat. - Bij
field=identifierkomt een waarde die nog geen product is maar in de Inbox wacht, terug alsstaged.
Antwoord
Het antwoord bevat results (één per afzonderlijke waarde, in volgorde van de aanvraag), summary en meta. Een waarde die niet wordt gevonden, dubbelzinnig of ongeldig is, is geen HTTP-fout: ze komt als eigen resultaat terug binnen de 200.
Resultaten per status
status | Veld | Betekenis |
|---|---|---|
found | value, matchedVia, product | Precies één product kwam overeen. |
not_found | value, archivedMatchCount (only when > 0) | Geen overeenkomst. |
staged | value, inbox { status: pending | dismissed, receivedAt } | Wacht in de Inbox, wordt nog niet gevolgd, dus er is nog geen conformiteitsstatus. |
ambiguous | value, matches [{ id, identifier, name }] | Meerdere producten kwamen overeen. |
ambiguous_truncated | value | De zoekopdracht bereikte zijn limiet aan kandidaten. Verfijn de waarde of gebruik identifier. Kan niet voorkomen bij field=gtin. |
invalid_value | value, reason: empty_value | value_too_long | value_precision_unsupported | not_a_gtin | De waarde kan niet worden opgezocht. |
matchedVia laat zien hoe een found-product is gevonden: identifier_exact, identifier_numeric_zerostrip, identifier_numeric_roundtrip, identifier_alnum, identifier_normalized, name_exact, name_normalized, gtin_exact, gtin_canonical.
summary telt de resultaten: requested, found, notFound, staged, ambiguous, invalid, duplicatesDropped. ambiguous omvat ambiguous_truncated; duplicatesDropped verschijnt alleen als er waarden zijn vervallen.
meta bevat resolvedField (het gebruikte veld), identifierField (hoe uw import de identificatiekolom noemde, ter informatie) en apiVersion.
Het productobject
Elke sleutel is altijd aanwezig, in deze volgorde. De kolommen van uw geïmporteerde spreadsheet worden nooit door de API teruggegeven.
| Veld | Type | Betekenis |
|---|---|---|
id | string | De vaste product-id van Conphora. Geen zoekwaarde. |
profileId | string | Het conformiteitsprofiel. |
identifier | string | Uw productidentificatiecode. |
identifierField | string | null | De naam die uw import aan de identificatiekolom geeft. |
gtin | string | null | De barcode als 14 cijfers, aangevuld met nullen; null als de import geen geldige barcode had. |
name | string | De productnaam. |
imageUrl | string | null | De afbeeldings-URL uit uw import. |
hsCode | string | null | De HS-code / goederencode. |
archived | boolean | True voor een gearchiveerd product. |
status.classification | in_progress | awaiting_clarification | completed | failed | null | Waar de classificatie staat; null als die nog niet is begonnen. |
status.compliance | not_checked | compliant | requires_compliance | De conformiteitsstatus. Nooit null: not_checked als het product nog nooit is beoordeeld. |
compliance.lastCheckedAt | number (ms epoch) | null | Wanneer het product voor het laatst is beoordeeld. |
compliance.summary.matchedCount | number | Hoeveel eisen van toepassing zijn. |
compliance.summary.fulfilledCount | number | Hoeveel daarvan zijn vervuld. |
compliance.progress | { compliance, attributes, documents }: { filled, total } | Paren ingevuld / totaal voor eisen, productgegevens en documenten; {0, 0} als er geen zijn. |
compliance.matchedRegulations[] | { id, shortName, fullTitle | null, eurLexUrl | null } | De regelgeving die van toepassing is. |
compliance.missingRequirements[] | { key, kind, regulation, requirementId, domain | null, label, deferred } | De openstaande eisen. kind is doc, attr, symbol of checkpoint. deferred = gemarkeerd als ‘Ik heb deze gegevens nog niet’; telt nog steeds als ontbrekend. |
riskScore | integer 0–100 | null | De Conphora Risk Score: een prioriteit, geen oordeel. Null tot het product een score heeft. |
riskBand | low | watch | high | critical | null | De band van de score. Null als er geen score is. |
nextAction | object | null | De ene volgende stap. Null als er geen score is of niets te doen is. |
nextAction.kind | string (see the list below) | Wat er te doen staat. |
nextAction.who | you | supplier | Wie er aan de beurt is. |
nextAction.href | string (relative platform path) | Een relatief pad op het platform dat de actie opent. Open het op de host van het platform. |
nextAction.after | number | De Risk Score zodra deze actie is gedaan. |
customerPack | object | null | Het klantpakket met alle tien onderdelen en hun status, uw werkoverzicht, hetzelfde als op de productpagina. Gevuld in het self-serviceabonnement; null bij de gratis check, en null als het profiel nog geen bedrijfsgegevens heeft. |
customerPack.ready | integer 0–10 | Hoeveel van de tien onderdelen gereed zijn. |
customerPack.total | 10 | Altijd 10. |
customerPack.items | object: item id → ready | missing | waiting | not-needed | De status van elk onderdeel, in pakketvolgorde. not-needed = geen enkel deel van het onderdeel is van toepassing op het product. |
customerPack.url | string | null | De volledige link naar de openbare klantpakketpagina van het product: de vaste link van het product zelf (dezelfde als in de export en de feed). null als er geen is, en bij de gratis check. |
customerPack.path | string | null | Dezelfde link als pad, /p/<token>, op de documentenhost. |
createdAt | number (ms epoch) | Wanneer het product in Conphora is aangemaakt. |
updatedAt | number (ms epoch) | Wanneer het product voor het laatst is gewijzigd. |
Risk Score, band en volgende actie
riskScore, riskBand en nextAction zijn op elk abonnement hetzelfde. De score zegt welke producten u het eerst moet herstellen; ze noemt een product nooit conform of non-conform. Een bekende non-conformiteit plaatst het product in critical, wat de score ook is.
riskBand | Score | Betekenis |
|---|---|---|
low | 0-24 | Gevolgd, niets te doen |
watch | 25-49 | Er komt iets aan |
high | 50-74 | Deze maand oplossen |
critical | 75-100 | Nu handelen |
nextAction.kind is een van een vaste set: clearNonCompliance, reEvaluate, uploadDocument, confirmRequirement, fillProductData, askSupplier, issueDeclaration, runProcedure, registerProduct, assembleTechnicalFile, renewDocument, reconfirmRuleChange, meetKeyDate, submitReport, chaseSupplier, reviewSupplierAnswer.
Onderdelen van het klantpakket
De sleutels van customerPack.items, in pakketvolgorde. Elke status is ready, missing, waiting of not-needed. identity, contact, declaration, standards-tests, safety-information, instructions, substances, packaging-epr, technical-file, recall-contact.
De API bewaart alle tien statussen. De openbare pakketpagina die uw klant opent, toont uw klant twee groepen: identity, contact, declaration, safety-information en instructions vanaf het begin, geteld als ‘n van 5 klaar om te vermelden’; standards-tests, substances, packaging-epr en recall-contact op verzoek, elk met een knop die u om het onderdeel vraagt; technical-file staat niet op de pagina.
Voorbeeldaanvraag
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_…" Voorbeeldantwoord
{
"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"
}
} Fouten
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 — Fouten
GET/api/v1/fields
Velden ontdekken
Toont welke `field`-waarden de opzoeking accepteert en hoe de import van het profiel de identificatiekolom noemt. Elk sleutelbereik; dezelfde profielregels als hierboven.
Sleutelbereik: readAbonnement: elk abonnement
Queryparameters
| Parameter | Type | Verplicht | Betekenis |
|---|---|---|---|
profileId | string | ja | Het conformiteitsprofiel. |
Antwoord
| Veld | Type | Betekenis |
|---|---|---|
profile.id | string | De profiel-id. |
profile.name | string | De profielnaam. |
identifierField | string | null | Hoe de nieuwste import de identificatiekolom noemt. |
supportedFields | string[] | Altijd ["identifier", "name", "gtin"]. |
meta.apiVersion | string | De API-versie. |
Voorbeeldaanvraag
curl "https://documents.conphora.com/api/v1/fields?profileId=jd7f3k2m9q8x4w1v6t5r0n3b2c" \
-H "x-api-key: cfa_live_…" Voorbeeldantwoord
{
"profile": {
"id": "jd7f3k2m9q8x4w1v6t5r0n3b2c",
"name": "Nordbirk ApS"
},
"identifierField": "SKU",
"supportedFields": [
"identifier",
"name",
"gtin"
],
"meta": {
"apiVersion": "2026-09-10"
}
} Fouten
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 — Fouten
POST/api/v1/intake
Producten pushen
Push per aanvraag tot 100 producten naar de Inbox van een profiel. Nieuwe identificatiecodes wachten in de Inbox tot iemand van uw team ze naar tracking verplaatst; een product waarvan de identificatiecode overeenkomt met een bestaand product, werkt dat product ter plekke bij. De push zelf wordt niet in rekening gebracht, en hetzelfde product opnieuw sturen verandert niets.
Sleutelbereik: read_writeAbonnement: self-serviceabonnement
Vereist een sleutel met het bereik read_write (anders 403 insufficient_scope) en het self-serviceabonnement (anders 403 membership_required). De body is JSON, maximaal 1 MB.
Aanvraagbody
| Veld | Type | Verplicht | Betekenis |
|---|---|---|---|
profileId | string | ja | Het doelprofiel voor conformiteit. |
products | array (1–100) | ja | De producten. Een latere dubbele uniqueId vervalt (de eerste wint) en wordt geteld. |
products[].uniqueId | string | number | ja | Uw productidentificatiecode, na trimmen maximaal 512 tekens. |
products[].name | string | ja | De productnaam (maximaal 10.000 tekens). |
products[].description | string | ja | De productbeschrijving. De classificatie van Conphora heeft die nodig. |
products[].gtin | string | number | nee | De barcode. Als die er is, moet het een geldige GTIN zijn, anders wordt de rij geweigerd met not_a_gtin. |
products[].imageUrl | string | nee | Een afbeeldings-URL. |
products[].attributes | object of string | number | boolean | null | nee | Alle andere kolommen, als vlak object. Maximaal 300 sleutels van maximaal 200 tekens; lange tekenreeksen worden afgekapt tot 10.000 tekens; geneste waarden worden geweigerd. Een sleutel die heet als een veld op het hoogste niveau, wordt overschreven door de waarde van dat veld. |
products[].hints | object: category → attribute keys | nee | Vertelt de classificatie welke attributen wat beschrijven. Elke sleutel moet in attributes bestaan en mag in één categorie voorkomen. |
Hintcategorieën: productDescription, material, productCategory, packaging, supplierInfo, other.
De Inbox van een profiel bevat maximaal 50.000 wachtende rijen; een push daarboven krijgt 429 intake_full.
Antwoord
results staan in volgorde van de aanvraag, één per product: uniqueId, status, en intakeId, productId of errors waar die van toepassing zijn.
Resultaten per status
status | Betekenis |
|---|---|
staged | Nieuw: wacht nu in de Inbox (intakeId). |
refreshed | Wachtte al; de inhoud is bijgewerkt. |
resurfaced | Was uit de Inbox verwijderd en komt terug als in behandeling omdat de inhoud is gewijzigd. |
unchanged | Al bekend en niets gewijzigd. |
updated | Kwam overeen met een actief product, dat is bijgewerkt (productId). |
updated_idle | Kwam overeen met een gearchiveerd product, dat ter plekke is bijgewerkt en gearchiveerd blijft. |
invalid | De rij is geweigerd: errors toont { field, reason }. |
Redenen voor invalid: required, invalid_type, too_long, not_a_gtin, too_many_attributes, unknown_category, reserved_key, unknown_attribute, assigned_twice.
summary telt de resultaten: received, staged, refreshed, unchanged, updated, updatedIdle, archivedSkipped, invalid, duplicatesDropped. received telt producten nadat dubbelen zijn vervallen; refreshed omvat resurfaced; archivedSkipped is altijd 0 en blijft bestaan voor oudere clients.
Mislukt een aanvraag halverwege met 500 intake_failed, dan zijn de producten vóór index completed opgeslagen en staan ze in results; stuur de rest opnieuw.
Voorbeeldaanvraag
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"
}
]
}' Voorbeeldantwoord
{
"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"
}
} Fouten
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 — Fouten
GET/feed/{token}
Productfeed
Een productfeed is een vaste URL die altijd de laatste gegevens van de actieve producten van één conformiteitsprofiel levert, als JSON, CSV of Excel. Er is geen API-sleutel nodig: het token in de URL is de toegangssleutel, dus iedereen die de URL heeft kan de feed lezen totdat u hem intrekt.
Een feedlink aanmaken en intrekken
- Open op het platform Tables, kies ‘Feed’ in de werkbalk en maak een link aan. De link neemt de kolommen over die op dat moment in de tabel zichtbaar zijn; u kunt later de kolommen wijzigen en er een label aan geven.
- Elke link heeft kopieerknoppen voor CSV, XLSX en JSON.
- Een link intrekken gaat direct in: de volgende aanvraag krijgt
404.
Feedlinks zijn beschikbaar op elk abonnement. De twee kolommen van het klantpakket zijn alleen gevuld in het self-serviceabonnement.
Queryparameters
| Parameter | Betekenis |
|---|---|
format | Het uitvoerformaat: json (de standaard), csv of xlsx. |
shared | Houd alleen de producten over met een open deellink van het klantpakket met dit label (de naam van uw klant, hoofdletterongevoelig), en laat de ‘Customer pack URL’ van elke rij naar die deellink wijzen in plaats van naar de vaste link van het product. Zo krijgt één klant een pakket op cataloguniveau. Leeg bij de gratis check, die geen deellinks heeft. |
Formaten
format | Betekenis |
|---|---|
json | Een array van objecten, één sleutel per kolomnaam. Gestructureerde kolommen zijn arrays en objecten, datums zijn ISO 8601, ontbrekende waarden zijn null. |
csv | UTF-8 met een koprij van kolomnamen, door komma’s gescheiden. Cellen met meerdere waarden worden met regeleinden samengevoegd. |
xlsx | Eén werkblad met dezelfde cellen als de CSV. |
Kolommen
Een link levert de voor die link gekozen kolommen, in deze volgorde: eerst uw eigen geïmporteerde kolommen onder hun eigen naam (identificatiecode, naam, dan de rest), anders dan de API bevat de feed wél uw geïmporteerde gegevens, daarna de kolommen van Conphora:
| Kolom | Betekenis |
|---|---|
EAN / GTIN | De 14-cijferige barcode. |
Commodity Code | De HS-code. |
Matched Regulations | De korte namen van de regelgeving die van toepassing is. |
Markets | De markten, met landcode en naam. |
EN Standards | De aanbevolen normen (op het platform getoond als ‘Recommended Standards’; de feed behoudt deze naam). |
Tested for | Waarop uw documenten laten zien dat het product is getest. |
Attributes | De productgegevens, label, waarde en eenheid. |
Attributes on Product | De attributen die op het product komen. |
Attributes on Packaging | De attributen die op de verpakking komen. |
Attributes in Documentation | De attributen die in de documentatie komen. |
Attributes in Online Listing | De attributen die in de online productvermelding komen. |
Document Links | Eén vermelding per document: titel, type, conformiteitsgebieden en een link naar het document. |
Customer pack | ‘6 of 10 ready’ en de status van elk van de tien onderdelen (de feed bewaart alle tien; de pakketpagina toont er vijf vanaf het begin en vier op verzoek) (in JSON: { ready, total, items }). Leeg, of null in JSON, bij de gratis check. |
Customer pack URL | De link naar de klantpakketpagina van het product: de vaste link van het product zelf, of de deellink van de shared-klant als u filtert. Leeg bij de gratis check. |
Created | Wanneer het product is aangemaakt. |
Updated | Wanneer het product voor het laatst is gewijzigd. |
De feed heeft geen kolom voor conformiteitsstatus, Risk Score of volgende actie; die staan in de API. De feed heeft geen versienummer: de kolomnamen vormen het contract, en de namen van uw geïmporteerde kolommen volgen uw imports.
Voorbeeldaanvraag
curl "https://documents.conphora.com/feed/<your-feed-token>?format=json" Voorbeeldantwoord
[
{
"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"
}
] Feedfouten zijn platte tekst, geen JSON: 404 als de link ongeldig of ingetrokken is, 413 als de export te groot zou worden (CSV is het compactste formaat).
Aanvraaglimieten
Lezen en schrijven hebben aparte limieten, elk geteld per API-sleutel en per organisatie (alle sleutels samen). Een aanvraag moet beide doorstaan. De cijfers zijn de huidige waarden, bedoeld om op hol geslagen scripts te stoppen, niet om normaal gebruik af te remmen.
| Aanvragen | Geteld per | Snelheid | Piek |
|---|---|---|---|
GET /api/v1/products, GET /api/v1/fields | API-sleutel | 600 / minuut | 120 |
GET /api/v1/products, GET /api/v1/fields | organisatie | 3,000 / minuut | 500 |
POST /api/v1/intake | API-sleutel | 120 / minuut | 30 |
POST /api/v1/intake | organisatie | 600 / minuut | 100 |
Boven de limiet antwoordt de API met 429 en de fout rate_limited, een veld retryAfterMs en een header Retry-After in seconden (minstens 1). Wacht zo lang voordat u het opnieuw probeert.
HTTP/1.1 429 Too Many Requests
Retry-After: 2
{
"error": "rate_limited",
"message": "Too many requests. Slow down and retry.",
"retryAfterMs": 1800
} Fouten
Elke fout van een `/api/v1`-endpoint is JSON van de vorm `{ "error": "<code>", "message": "<text>" }`, soms met extra velden, verstuurd met de HTTP-status. Baseer uw logica op `error`, nooit op `message`. Een verkeerde methode of een onbekend pad hoort niet bij deze endpoints en antwoordt niet in deze vorm.
| Status | error | Wanneer | Extra velden | Endpoints |
|---|---|---|---|---|
| 400 | missing_parameter | Geen profileId, geen waarden, of geen products / een lege array. | alle | |
| 400 | too_many_values | Meer dan 100 afzonderlijke waarden. | maxValues | GET /api/v1/products |
| 400 | unknown_field | field is niet identifier, name of gtin. | supportedFields | GET /api/v1/products |
| 400 | invalid_profile_id | profileId is geen goed gevormde id. | alle | |
| 400 | invalid_json | De body is geen JSON. | POST /api/v1/intake | |
| 400 | invalid_payload | De body is geen object, of products is geen array. | POST /api/v1/intake | |
| 400 | too_many_products | Meer dan 100 producten. | maxProducts | POST /api/v1/intake |
| 401 | missing_api_key | Er is geen sleutel meegestuurd. | alle | |
| 401 | invalid_api_key | De sleutel is onbekend. | alle | |
| 401 | revoked_api_key | De sleutel is ingetrokken. | alle | |
| 403 | insufficient_scope | Een read-sleutel riep de intake aan. | POST /api/v1/intake | |
| 403 | profile_not_allowed | De sleutel is aan een ander profiel gekoppeld. | alle | |
| 403 | membership_required | De organisatie heeft geen actief self-serviceabonnement. | POST /api/v1/intake | |
| 404 | profile_not_found | Het profiel bestaat niet of hoort bij een andere organisatie. | alle | |
| 413 | response_too_large | Het resultaat zou groter zijn dan ongeveer 18 MB. Vraag minder waarden op. | GET /api/v1/products | |
| 413 | payload_too_large | De body is groter dan 1 MB. | maxBodyBytes | POST /api/v1/intake |
| 429 | rate_limited | Een aanvraaglimiet is bereikt. | retryAfterMs + Retry-After header | alle |
| 429 | intake_full | De Inbox van het profiel zou boven 50.000 wachtende rijen uitkomen. | POST /api/v1/intake | |
| 500 | intake_failed | De aanvraag is halverwege mislukt; de producten vóór index completed zijn opgeslagen. | completed, results | POST /api/v1/intake |
| 503 | rate_limiter_unavailable | Schrijven is even niet beschikbaar. Probeer opnieuw na de header Retry-After. | Retry-After header | POST /api/v1/intake |
Versiebeheer
- De versie staat in het pad (
/api/v1) en in elke antwoordbody alsmeta.apiVersion. - Er kunnen op elk moment velden worden toegevoegd. Bouw clients die velden die ze niet kennen negeren.
- Een brekende wijziging verandert de versie.
meta.apiVersion: "2026-09-10"