Conphora API Dokumentation

Alt du behøver for at integrere med Conphoras compliance-platform.

Oversigt

Conphora API er en RESTful JSON-baseret API, der giver fuld adgang til compliance-platformen. Alle requests og responses anvender application/json.

Base URL https://api.conphora.com/v1
Autentificering Bearer token (API-nøgle)
Format JSON (application/json)
Rate limit (Standard) 100 requests / minut
Rate limit (Enterprise) 1.000 requests / minut
Versionering URL-baseret (/v1, /v2 osv.)

Autentificering

Alle API-kald kræver en gyldig API-nøgle. Du opretter en API-nøgle under Indstillinger → API-nøgler i dit Conphora Dashboard.

Tilladelsesniveauer

  • Read-only — kan kun læse data (GET-endpoints).
  • Read-write — fuld adgang til alle endpoints, inkl. oprettelse, opdatering og sletning.

Send din API-nøgle som Bearer token i Authorization-headeren:

Authorization Header Bash 
curl -X GET https://api.conphora.com/v1/products \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

Produkter

Administrer produkter i Conphora-platformen. Hvert produkt kan have materialer, markeder og attributter tilknyttet.

Metode Endpoint Beskrivelse
GET /products Hent liste over alle produkter
GET /products/{id} Hent et specifikt produkt
POST /products Opret nyt produkt
PUT /products/{id} Opdater et eksisterende produkt
DELETE /products/{id} Slet et produkt

Eksempel: Opret produkt

POST /products – Request JSON 
{
  "name": "Smart Sensor X1",
  "sku": "SS-X1-2025",
  "category": "electronics_iot",
  "markets": ["EU", "UK"],
  "materials": ["ABS plastic", "lithium battery", "PCB"],
  "attributes": {
    "voltage": "5V DC",
    "wireless": true,
    "battery_type": "Li-ion 3.7V 2000mAh"
  }
}
POST /products – Response (201 Created) JSON 
{
  "id": "prod_xyz789",
  "name": "Smart Sensor X1",
  "sku": "SS-X1-2025",
  "status": "pending_validation",
  "created_at": "2025-09-15T10:00:00Z"
}

Compliance

Hent compliance-status og valider produkter mod gældende EU-regulativer.

Metode Endpoint Beskrivelse
GET /products/{id}/compliance Hent compliance-status for et produkt
POST /products/{id}/validate Start validering af et produkt
GET /products/{id}/compliance/details Hent detaljeret compliance-rapport

Eksempel: Compliance-status

GET /products/{id}/compliance – Response JSON 
{
  "product_id": "prod_xyz789",
  "overall_status": "partially_compliant",
  "regulations": [
    {
      "regulation": "REACH",
      "status": "compliant",
      "last_checked": "2025-09-15T12:00:00Z"
    },
    {
      "regulation": "RoHS",
      "status": "action_required",
      "issues": ["Lead content in solder exceeds threshold"],
      "last_checked": "2025-09-15T12:00:00Z"
    },
    {
      "regulation": "Battery Directive",
      "status": "compliant",
      "last_checked": "2025-09-15T12:00:00Z"
    }
  ]
}

Dokumentation

Generer og hent compliance-dokumenter som EU Declaration of Conformity, teknisk dokumentation m.m.

Metode Endpoint Beskrivelse
GET /products/{id}/documents Hent liste over dokumenter for et produkt
POST /products/{id}/documents/generate Generer et nyt compliance-dokument
GET /documents/{doc_id}/download Download et specifikt dokument

Batch-operationer

Udfør operationer på flere produkter samtidigt. Maksimalt 100 produkter per batch-request.

Metode Endpoint Beskrivelse
POST /products/batch Opret op til 100 produkter i én request
POST /products/batch/validate Valider op til 100 produkter i én request

Webhooks

Modtag realtime-notifikationer når vigtige hændelser sker i din Conphora-konto. Webhooks konfigureres under Indstillinger → Webhooks i dit Dashboard.

Tilgængelige events

  • product.validated — Et produkt er blevet valideret
  • compliance.changed — Compliance-status er ændret for et produkt
  • regulation.updated — Et regulativ er blevet opdateret

Webhook-payload eksempel

Webhook Payload JSON 
{
  "event": "compliance.changed",
  "timestamp": "2025-09-15T14:30:00Z",
  "data": {
    "product_id": "prod_xyz789",
    "product_name": "Smart Sensor X1",
    "previous_status": "compliant",
    "new_status": "action_required",
    "affected_regulations": ["RoHS"],
    "details": "Lead content threshold updated in RoHS amendment."
  }
}

Fejlhåndtering

Conphora API bruger standard HTTP-statuskoder til at indikere succes eller fejl.

Kode Betydning
200OK — Anmodningen lykkedes
201Created — Ressource oprettet
400Bad Request — Ugyldig request-body eller parametre
401Unauthorized — Manglende eller ugyldig API-nøgle
403Forbidden — API-nøglen har ikke tilstrækkelige tilladelser
404Not Found — Ressourcen blev ikke fundet
429Too Many Requests — Rate limit overskredet
500Internal Server Error — Uventet fejl på serveren

Fejl-response format

Error Response (400) JSON 
{
  "error": {
    "code": "validation_error",
    "message": "Feltet 'sku' er påkrævet.",
    "details": [
      {
        "field": "sku",
        "issue": "required",
        "message": "SKU skal angives for alle produkter."
      }
    ]
  }
}

SDKs

Officielle SDKs er under udvikling og vil snart blive tilgængelige for følgende sprog:

🐍 Python Under udvikling
⬡ Node.js Under udvikling
🐘 PHP Under udvikling

Eksempel: Python med requests

Python SDK-eksempel Python 
import requests

API_KEY = "YOUR_API_KEY"
BASE_URL = "https://api.conphora.com/v1"

headers = {
    "Authorization": f"Bearer {API_KEY}",
    "Content-Type": "application/json"
}

# Hent alle produkter
response = requests.get(f"{BASE_URL}/products", headers=headers)
products = response.json()

# Opret nyt produkt
new_product = {
    "name": "Smart Sensor X1",
    "sku": "SS-X1-2025",
    "category": "electronics_iot",
    "markets": ["EU", "UK"],
    "materials": ["ABS plastic", "lithium battery", "PCB"]
}

response = requests.post(
    f"{BASE_URL}/products",
    json=new_product,
    headers=headers
)
created = response.json()
print(f"Produkt oprettet: {created['id']}")