Utvecklare

Conphoras API-referens

Läs status för regelefterlevnad, Risk Score och kundpaket för dina produkter från dina egna system, skicka in nya produkter i Conphora och hämta hela ditt sortiment som ett levande flöde. API:et är avsett att anropas från en server.

Skapa en API-nyckel
Bas-URL
https://documents.conphora.com
Aktuell version
/api/v1 · meta.apiVersion: "2026-09-10"

Läs-API:et (GET /api/v1/products, GET /api/v1/fields) och produktflödet finns i varje abonnemang. POST /api/v1/intake kräver självbetjäningsabonnemanget och en read_write-nyckel.

Börja här

Autentisering

Varje API-förfrågan bär en API-nyckel. En nyckel tillhör en organisation och kan bara läsa den organisationens profiler för regelefterlevnad.

Skapa en nyckel

  1. Öppna Inställningar → API-nycklar på plattformen och skapa en nyckel. Ge den ett namn för eget bruk.
  2. Välj behörighet: lämna ”Tillåt att den här nyckeln skickar in produkter till Inkorgen” omarkerad för en skrivskyddad nyckel, markera den för en read_write-nyckel.
  3. Om din organisation har två eller flera profiler för regelefterlevnad kan du binda nyckeln till en av dem.
  4. Kopiera nyckeln. Den börjar med cfa_live_ och visas bara en gång: Conphora kan inte visa den igen. Om du tappar bort den, återkalla den och skapa en ny.

Nyckellistan visar varje nyckels första tecken, namn, behörighet, profilbindning, när den skapades och när den senast användes. Att återkalla en nyckel gäller omedelbart; nyckeln får då 401 revoked_api_key. Du kan byta namn på en nyckel, men inte ändra dess behörighet eller bindning, skapa i stället en ny nyckel.

Skicka nyckeln

Skicka nyckeln i headern x-api-key. Authorization: Bearer <key> accepteras också; om båda skickas gäller x-api-key.

Exempel: påhittade dataHTTP
x-api-key: cfa_live_…
# or
Authorization: Bearer cfa_live_…

Använd nyckeln bara på din server, aldrig i JavaScript i webbutiken eller webbläsaren. Webbläsare som anropar API:et direkt stöds inte.

Behörigheter

Behörigheter
Nyckelns behörighetBetydelse
readGET /api/v1/products och GET /api/v1/fields. Standard.
read_writeAllt som read kan anropa, plus POST /api/v1/intake.

Behörigheten fastställs när nyckeln skapas.

Profilbindning

  • En nyckel som är bunden till en profil får bara ange den profilen. Varje annat profileId ger 403 profile_not_allowed.
  • En obunden nyckel får ange vilken profil som helst i sin organisation. En profil som inte finns, eller som tillhör en annan organisation, ger 404 profile_not_found.

Var du hittar ditt profil-id

Varje slutpunkt behöver ett profileId: id:t för en profil för regelefterlevnad på plattformen. Inställningar → API-nycklar visar ett exempel på förfrågan som redan innehåller det. GET /api/v1/fields returnerar profilens id och namn, så att du kan kontrollera att du har rätt profil.

GET/api/v1/products

Slå upp produkter

Slå upp 1 till 100 produkter med din egen identifierare, med namn eller med streckkod, och få deras status för regelefterlevnad, Risk Score, nästa åtgärd och kundpaket. Det finns ingen slutpunkt som listar ett helt sortiment; använd produktflödet för det.

Nyckelns behörighet: readAbonnemang: varje abonnemang

Frågeparametrar

ParameterTypObligatoriskStandardBetydelse
profileIdstringjaDen profil för regelefterlevnad som ska sökas i. Den måste tillhöra nyckelns organisation och stämma med nyckelns bindning om nyckeln är bunden.
valuesstring (comma-separated or repeated)jaDe värden som ska slås upp. values=A,B,C och values=A&values=B fungerar båda; använd den upprepade formen när ett värde innehåller ett kommatecken. Värden trimmas, tomma värden tas bort och exakta dubbletter tas bort och räknas. Högst 100 efter att dubbletter har tagits bort.
valuestringaliasAccepteras som alias för values och slås ihop med det.
fieldidentifier | name | gtinnejidentifierVad värdena är: identifier = din egen produktidentifierare (den kolumn som din import mappade som identifierare, till exempel ”SKU”), name = produktnamnet, gtin = en EAN-, UPC- eller GTIN-streckkod. Skiftlägesokänsligt. Inga andra namn accepteras.
includeArchivedtruenejfalseTa med arkiverade produkter. Utan den utelämnas arkiverade träffar, och ett not_found-resultat anger archivedMatchCount när arkiverade produkter matchade.

Så fungerar matchningen

  • identifier: först en exakt matchning, sedan toleranta varianter, inledande nollor i värden som bara består av siffror ignoreras (”0012345” hittar ”12345”), därefter skiljetecken, därefter skiftläge. Värden som bara består av siffror och är längre än 15 siffror avvisas som value_precision_unsupported. Ett värde får vara högst 512 tecken.
  • gtin: streckkoden normaliseras till den 14-siffriga GS1-formen och matchas exakt. 8, 12, 13 och 14 siffror samt skiljetecken går bra; allt annat blir not_a_gtin.
  • name: först det exakta namnet, sedan en sökning som bortser från skiftläge och skiljetecken.
  • När mer än en produkt matchar blir resultatet ambiguous med kandidaterna. API:et gissar aldrig: fråga igen med en kandidats identifier.
  • Med field=identifier kommer ett värde som ännu inte är en produkt men väntar i Inkorgen tillbaka som staged.

Svar

Svaret har results (ett per distinkt värde, i förfrågans ordning), summary och meta. Ett värde som inte hittas, är tvetydigt eller är ogiltigt är inget HTTP-fel: det kommer tillbaka inuti 200 som ett eget resultat.

Resultat per status

statusFältBetydelse
foundvalue, matchedVia, productExakt en produkt matchade.
not_foundvalue, archivedMatchCount (only when > 0)Ingen träff.
stagedvalue, inbox { status: pending | dismissed, receivedAt }Väntar i Inkorgen, ännu inte bevakad, så det finns inget överensstämmelsetillstånd än.
ambiguousvalue, matches [{ id, identifier, name }]Flera produkter matchade.
ambiguous_truncatedvalueSökningen nådde sin gräns för kandidater. Snäva in värdet eller använd identifier. Kan inte inträffa med field=gtin.
invalid_valuevalue, reason: empty_value | value_too_long | value_precision_unsupported | not_a_gtinVärdet kan inte slås upp.

matchedVia talar om hur en found-produkt matchade: identifier_exact, identifier_numeric_zerostrip, identifier_numeric_roundtrip, identifier_alnum, identifier_normalized, name_exact, name_normalized, gtin_exact, gtin_canonical.

summary räknar resultaten: requested, found, notFound, staged, ambiguous, invalid, duplicatesDropped. ambiguous omfattar ambiguous_truncated; duplicatesDropped visas bara när värden har tagits bort.

meta innehåller resolvedField (det fält som användes), identifierField (vad din import kallade identifierarkolumnen, för information) och apiVersion.

Produktobjektet

Varje nyckel finns alltid med, i den här ordningen. Kolumnerna i ditt importerade kalkylblad returneras aldrig av API:et.

FältTypBetydelse
idstringConphoras stabila produkt-id. Inte ett uppslagsvärde.
profileIdstringProfilen för regelefterlevnad.
identifierstringDin produktidentifierare.
identifierFieldstring | nullDin imports namn på identifierarkolumnen.
gtinstring | nullStreckkoden som 14 siffror, utfylld med nollor; null när importen inte hade någon giltig streckkod.
namestringProduktnamnet.
imageUrlstring | nullBild-URL:en från din import.
hsCodestring | nullHS-koden / varukoden.
archivedbooleantrue för en arkiverad produkt.
status.classificationin_progress | awaiting_clarification | completed | failed | nullVar klassificeringen står; null när den inte har börjat.
status.compliancenot_checked | compliant | requires_complianceÖverensstämmelsetillståndet. Aldrig null: not_checked när produkten aldrig har utvärderats.
compliance.lastCheckedAtnumber (ms epoch) | nullNär produkten senast utvärderades.
compliance.summary.matchedCountnumberHur många krav som gäller.
compliance.summary.fulfilledCountnumberHur många av dem som är uppfyllda.
compliance.progress{ compliance, attributes, documents }: { filled, total }Par av ifyllt / totalt för krav, produktdata och dokument; {0, 0} när det inte finns några.
compliance.matchedRegulations[]{ id, shortName, fullTitle | null, eurLexUrl | null }De förordningar som gäller.
compliance.missingRequirements[]{ key, kind, regulation, requirementId, domain | null, label, deferred }De öppna kraven. kind är doc, attr, symbol eller checkpoint. deferred = markerat ”Jag har inte de här uppgifterna ännu”; räknas ändå som saknat.
riskScoreinteger 0–100 | nullConphora Risk Score: en prioritering, inte en dom. Null tills produkten har poängsatts.
riskBandlow | watch | high | critical | nullPoängens nivå. Null när det inte finns någon poäng.
nextActionobject | nullDet enda nästa som ska göras. Null när det inte finns någon poäng eller inget att göra.
nextAction.kindstring (see the list below)Vad som ska göras.
nextAction.whoyou | supplierVems tur det är.
nextAction.hrefstring (relative platform path)En relativ sökväg på plattformen som öppnar åtgärden. Öppna den på plattformens värd.
nextAction.afternumberRisk Score när åtgärden är gjord.
customerPackobject | nullKundpaketet med alla tio poster och deras status, din arbetsvy, densamma som på produktsidan. Ifyllt i självbetjäningsabonnemanget; null i gratiskontrollen, och null när profilen ännu inte har några företagsuppgifter.
customerPack.readyinteger 0–10Hur många av de tio posterna som är klara.
customerPack.total10Alltid 10.
customerPack.itemsobject: item id → ready | missing | waiting | not-neededVarje posts status, i paketets ordning. not-needed = ingen del av posten gäller produkten.
customerPack.urlstring | nullHela länken till produktens publika kundpaketssida: produktens egen stående länk (samma som exporten och flödet bär). null när det inte finns någon, och i gratiskontrollen.
customerPack.pathstring | nullSamma länk som en sökväg, /p/<token>, på dokumentvärden.
createdAtnumber (ms epoch)När produkten skapades i Conphora.
updatedAtnumber (ms epoch)När produkten senast ändrades.

Risk Score, nivå och nästa åtgärd

riskScore, riskBand och nextAction är desamma i varje abonnemang. Poängen anger vilka produkter som ska åtgärdas först; den kallar aldrig en produkt överensstämmande eller icke-överensstämmande. En känd bristande överensstämmelse placerar produkten i critical oavsett poäng.

Risknivåer
riskBandPoängBetydelse
low0-24Bevakas, inget att göra
watch25-49Något är på väg
high50-74Åtgärda den här månaden
critical75-100Agera nu

nextAction.kind är en av en fast uppsättning: clearNonCompliance, reEvaluate, uploadDocument, confirmRequirement, fillProductData, askSupplier, issueDeclaration, runProcedure, registerProduct, assembleTechnicalFile, renewDocument, reconfirmRuleChange, meetKeyDate, submitReport, chaseSupplier, reviewSupplierAnswer.

Så fungerar Risk Score

Poster i kundpaketet

Nycklarna i customerPack.items, i paketets ordning. Varje status är ready, missing, waiting eller not-needed. identity, contact, declaration, standards-tests, safety-information, instructions, substances, packaging-epr, technical-file, recall-contact.

API:et behåller alla tio statusar. Den publika paketsida som din kund öppnar visar din kund två grupper: identity, contact, declaration, safety-information och instructions från start, räknade som ”n av 5 klara för listning”; standards-tests, substances, packaging-epr och recall-contact på begäran, var och en med en knapp som frågar dig; technical-file finns inte på sidan.

Exempel på förfrågan

Exempel: påhittade datacurl
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_…"

Exempel på svar

Exempel: påhittade dataJSON
{
  "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"
  }
}

Fel

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 — Fel

GET/api/v1/fields

Ta reda på fält

Visar vilka `field`-värden som uppslaget accepterar och vad profilens import kallar sin identifierarkolumn. Valfri nyckelbehörighet; samma profilregler som ovan.

Nyckelns behörighet: readAbonnemang: varje abonnemang

Frågeparametrar

ParameterTypObligatoriskBetydelse
profileIdstringjaProfilen för regelefterlevnad.

Svar

FältTypBetydelse
profile.idstringProfil-id:t.
profile.namestringProfilens namn.
identifierFieldstring | nullVad den senaste importen kallar identifierarkolumnen.
supportedFieldsstring[]Alltid ["identifier", "name", "gtin"].
meta.apiVersionstringAPI-versionen.

Exempel på förfrågan

Exempel: påhittade datacurl
curl "https://documents.conphora.com/api/v1/fields?profileId=jd7f3k2m9q8x4w1v6t5r0n3b2c" \
  -H "x-api-key: cfa_live_…"

Exempel på svar

Exempel: påhittade dataJSON
{
  "profile": {
    "id": "jd7f3k2m9q8x4w1v6t5r0n3b2c",
    "name": "Nordbirk ApS"
  },
  "identifierField": "SKU",
  "supportedFields": [
    "identifier",
    "name",
    "gtin"
  ],
  "meta": {
    "apiVersion": "2026-09-10"
  }
}

Fel

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 — Fel

POST/api/v1/intake

Skicka in produkter

Skicka in upp till 100 produkter per förfrågan till en profils Inkorg. Nya identifierare väntar i Inkorgen tills någon i ditt team flyttar dem till bevakning; en produkt vars identifierare matchar en befintlig produkt uppdaterar den produkten på plats. Själva inskickningen debiteras inte, och att skicka samma produkt igen ändrar ingenting.

Nyckelns behörighet: read_writeAbonnemang: självbetjäningsabonnemang

Kräver en nyckel med behörigheten read_write (annars 403 insufficient_scope) och självbetjäningsabonnemanget (annars 403 membership_required). Innehållet är JSON, högst 1 MB.

Förfrågans innehåll

FältTypObligatoriskBetydelse
profileIdstringjaDen profil för regelefterlevnad som ska ta emot produkterna.
productsarray (1–100)jaProdukterna. En senare dubblett av ett uniqueId tas bort (den första gäller) och räknas.
products[].uniqueIdstring | numberjaDin produktidentifierare, högst 512 tecken efter trimning.
products[].namestringjaProduktnamnet (högst 10 000 tecken).
products[].descriptionstringjaProduktbeskrivningen. Conphoras klassificering behöver den.
products[].gtinstring | numbernejStreckkoden. När den finns måste den vara en giltig GTIN, annars avvisas raden med not_a_gtin.
products[].imageUrlstringnejEn bild-URL.
products[].attributesobject of string | number | boolean | nullnejAlla andra kolumner, som ett platt objekt. Högst 300 nycklar på högst 200 tecken; långa strängar kortas till 10 000 tecken; nästlade värden avvisas. En nyckel som heter som ett toppnivåfält skrivs över av toppnivåvärdet.
products[].hintsobject: category → attribute keysnejTalar om för klassificeringen vilka attribut som beskriver vad. Varje nyckel måste finnas i attributes och får förekomma i endast en kategori.

Tipskategorier: productDescription, material, productCategory, packaging, supplierInfo, other.

En profils Inkorg rymmer högst 50 000 väntande rader; en inskickning utöver det ger 429 intake_full.

Svar

results kommer i förfrågans ordning, ett per produkt: uniqueId, status, samt intakeId, productId eller errors där de är aktuella.

Resultat per status

statusBetydelse
stagedNy: väntar nu i Inkorgen (intakeId).
refreshedVäntade redan; innehållet uppdaterades.
resurfacedHade avfärdats från Inkorgen och kom tillbaka som väntande eftersom innehållet ändrades.
unchangedRedan känd, och ingenting ändrades.
updatedMatchade en aktiv produkt, som uppdaterades (productId).
updated_idleMatchade en arkiverad produkt, som uppdaterades på plats och förblir arkiverad.
invalidRaden avvisades: errors listar { field, reason }.

Orsaker till invalid: required, invalid_type, too_long, not_a_gtin, too_many_attributes, unknown_category, reserved_key, unknown_attribute, assigned_twice.

summary räknar resultaten: received, staged, refreshed, unchanged, updated, updatedIdle, archivedSkipped, invalid, duplicatesDropped. received räknar produkter efter att dubbletter har tagits bort; refreshed omfattar resurfaced; archivedSkipped är alltid 0 och finns kvar för äldre klienter.

Om en förfrågan misslyckas halvvägs med 500 intake_failed sparades produkterna före index completed och results listar dem; skicka resten igen.

Exempel på förfrågan

Exempel: påhittade datacurl
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"
    }
  ]
}'

Exempel på svar

Exempel: påhittade dataJSON
{
  "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"
  }
}

Fel

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 — Fel

GET/feed/{token}

Produktflöde

Ett produktflöde är en fast URL som alltid levererar de senaste uppgifterna för en profils aktiva produkter, som JSON, CSV eller Excel. Det behöver ingen API-nyckel: token i URL:en är behörigheten, så den som har URL:en kan läsa flödet tills du återkallar det.

Skapa och återkalla en flödeslänk

  1. Öppna Tabeller på plattformen, välj ”Flöde” i verktygsfältet och skapa en länk. Länken tar de kolumner som är synliga i tabellen i det ögonblicket; du kan ändra dess kolumner och ge den en etikett senare.
  2. Varje länk har kopieringsknappar för CSV, XLSX och JSON.
  3. Att återkalla en länk gäller omedelbart: nästa förfrågan får 404.

Flödeslänkar finns i varje abonnemang. De två kolumnerna för kundpaket är ifyllda endast i självbetjäningsabonnemanget.

Frågeparametrar

ParameterBetydelse
formatUtdataformatet: json (standard), csv eller xlsx.
sharedBehåll bara de produkter som har en öppen delningslänk för kundpaket med den här etiketten (din kunds namn, skiftlägesokänsligt), och peka varje rads ”Customer pack URL” mot den delningen i stället för produktens stående länk. Det ger en kund ett kundpaket på sortimentsnivå. Tomt i gratiskontrollen, som inte har några delningslänkar.

Format

formatBetydelse
jsonEn array av objekt, en nyckel per kolumnnamn. Strukturerade kolumner är arrayer och objekt, datum är ISO 8601, saknade värden är null.
csvUTF-8 med en rubrikrad med kolumnnamn, kommaseparerad. Celler med flera värden sammanfogas med radbrytningar.
xlsxEtt blad med samma celler som CSV-filen.

Kolumner

En länk levererar de kolumner som valts för den, i den här ordningen: först dina egna importerade kolumner under sina egna namn (identifierare, namn, därefter resten), till skillnad från API:et innehåller flödet dina importerade data, därefter Conphoras kolumner:

KolumnBetydelse
EAN / GTINDen 14-siffriga streckkoden.
Commodity CodeHS-koden.
Matched RegulationsKortnamnen på de förordningar som gäller.
MarketsMarknaderna, med landskod och namn.
EN StandardsDe rekommenderade standarderna (visas på plattformen som ”Recommended Standards”; flödet behåller det här namnet).
Tested forVad dina dokument visar att produkten har provats för.
AttributesProduktdata, etikett, värde och enhet.
Attributes on ProductDe attribut som anges på produkten.
Attributes on PackagingDe attribut som anges på förpackningen.
Attributes in DocumentationDe attribut som anges i dokumentationen.
Attributes in Online ListingDe attribut som anges i onlineannonsen.
Document LinksEn post per dokument: titel, typ, områden för regelefterlevnad och en länk till dokumentet.
Customer pack”6 av 10 klara” och status för var och en av de tio posterna (flödet behåller alla tio; paketsidan visar fem från start och fyra på begäran) (i JSON: { ready, total, items }). Tomt, eller null i JSON, i gratiskontrollen.
Customer pack URLLänken till produktens kundpaketssida: produktens egen stående länk, eller den delning som tillhör shared-kunden när du filtrerar. Tomt i gratiskontrollen.
CreatedNär produkten skapades.
UpdatedNär produkten senast ändrades.

Flödet har ingen kolumn för status för regelefterlevnad, Risk Score eller nästa åtgärd; de finns i API:et. Flödet har inget versionsnummer: dess kolumnnamn är dess kontrakt, och dina importerade kolumnnamn följer dina importer.

Exempel på förfrågan

Exempel: påhittade datacurl
curl "https://documents.conphora.com/feed/<your-feed-token>?format=json"

Exempel på svar

Exempel: påhittade dataJSON
[
  {
    "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"
  }
]

Flödesfel är oformaterad text, inte JSON: 404 när länken är ogiltig eller återkallad, 413 när exporten skulle bli för stor (CSV är det mest kompakta formatet).

Hastighetsgränser

Läsning och skrivning har separata gränser, var och en räknad per API-nyckel och per organisation (alla nycklar tillsammans). En förfrågan måste klara båda. Siffrorna är dagens värden, satta för att stoppa skenande skript, inte för att strypa normal användning.

AnropRäknas perFrekvensBurst
GET /api/v1/products, GET /api/v1/fieldsAPI-nyckel600 / minut120
GET /api/v1/products, GET /api/v1/fieldsorganisation3,000 / minut500
POST /api/v1/intakeAPI-nyckel120 / minut30
POST /api/v1/intakeorganisation600 / minut100

Över gränsen svarar API:et med 429 och felet rate_limited, ett fält retryAfterMs och en header Retry-After i sekunder (minst 1). Vänta så länge innan du försöker igen.

Exempel: påhittade dataHTTP
HTTP/1.1 429 Too Many Requests
Retry-After: 2

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

Fel

Varje fel från en `/api/v1`-slutpunkt är JSON med formen `{ "error": "<code>", "message": "<text>" }`, ibland med extra fält, skickat med HTTP-statusen. Styr logiken efter `error`, aldrig efter `message`. En felaktig metod eller en okänd sökväg tillhör inte de här slutpunkterna och svarar inte i den här formen.

StatuserrorNärExtra fältSlutpunkter
400missing_parameterInget profileId, inga värden, eller ingen products / en tom array.alla
400too_many_valuesFler än 100 distinkta värden.maxValuesGET /api/v1/products
400unknown_fieldfield är inte identifier, name eller gtin.supportedFieldsGET /api/v1/products
400invalid_profile_idprofileId är inte ett välformat id.alla
400invalid_jsonInnehållet är inte JSON.POST /api/v1/intake
400invalid_payloadInnehållet är inte ett objekt, eller products är inte en array.POST /api/v1/intake
400too_many_productsFler än 100 produkter.maxProductsPOST /api/v1/intake
401missing_api_keyIngen nyckel skickades.alla
401invalid_api_keyNyckeln är okänd.alla
401revoked_api_keyNyckeln har återkallats.alla
403insufficient_scopeEn read-nyckel anropade inskickningen.POST /api/v1/intake
403profile_not_allowedNyckeln är bunden till en annan profil.alla
403membership_requiredOrganisationen har inget aktivt självbetjäningsabonnemang.POST /api/v1/intake
404profile_not_foundProfilen finns inte eller tillhör en annan organisation.alla
413response_too_largeResultatet skulle bli större än cirka 18 MB. Be om färre värden.GET /api/v1/products
413payload_too_largeInnehållet är större än 1 MB.maxBodyBytesPOST /api/v1/intake
429rate_limitedEn hastighetsgräns nåddes.retryAfterMs + Retry-After headeralla
429intake_fullProfilens Inkorg skulle passera 50 000 väntande rader.POST /api/v1/intake
500intake_failedFörfrågan misslyckades halvvägs; produkterna före index completed sparades.completed, resultsPOST /api/v1/intake
503rate_limiter_unavailableSkrivning är tillfälligt otillgänglig. Försök igen efter headern Retry-After.Retry-After headerPOST /api/v1/intake

Versionshantering

  • Versionen finns i sökvägen (/api/v1) och i varje svarsinnehåll som meta.apiVersion.
  • Fält kan läggas till när som helst. Bygg klienter som ignorerar fält de inte känner till.
  • En ändring som bryter kompatibiliteten ändrar versionen.

meta.apiVersion: "2026-09-10"

Redo att ansluta?

Skapa en nyckel under Inställningar → API-nycklar på plattformen och gör ditt första uppslag.

Skapa en API-nyckel