API for invitasjoner, anmeldelser og widgets

Autentisering

Opprett en nøkkel under Dashboard → API. Send den som en Bearer-token. Nøkler starter med rnq_ og er begrenset til ett selskap.

Authorization: Bearer rnq_…

Nøkkelen får kun tilgang til selskapet den ble opprettet for. Aldri eksponer den i klientkode.

Administrer API-nøkler →

Endepunkter

Alle v1 endepunkter krever Authorization-header. JSON inn og ut. Feed-URL-en er offentlig (token i banen).

Organisasjon

Returnerer RanqaScore, gjennomsnittlig vurdering, anmeldelsestall og klare widget-lenker.

GET https://ranqa.me/api/v1/organization
Authorization: Bearer rnq_…

{
  "id": "…",
  "name": "Example AB",
  "slug": "example-ab",
  "primaryDomain": "example.com",
  "plan": "pro",
  "ranqaScore": 4.6,
  "averageRating": 4.4,
  "reviewCount": 128,
  "publicUrl": "https://ranqa.me/example.com",
  "widgets": {
    "badge": "https://ranqa.me/widget/example-ab?type=badge",
    "mini": "https://ranqa.me/widget/example-ab?type=mini",
    "carousel": "https://ranqa.me/widget/example-ab?type=carousel",
    "gallery": "https://ranqa.me/widget/example-ab?type=gallery",
    "collect": "https://ranqa.me/widget/example-ab?type=collect",
    "quote": "https://ranqa.me/widget/example-ab?type=quote"
  }
}

Invitasjoner

Send invitasjoner etter levering eller kjøp. Gratis planer har en månedlig kvote; Growth og Pro er ubegrenset.

Opprett invitasjoner

POST https://ranqa.me/api/v1/invites
Content-Type: application/json
Authorization: Bearer rnq_…

{
  "recipients": [
    {
      "email": "[email protected]",
      "name": "Anna",
      "orderId": "ORD-123",
      "productId": null,
      "verifiedPurchase": true
    }
  ],
  "sendEmail": true
}

verifiedPurchase: true gir den verifiserte kunde-badge. Bruk kun med en bestilling/CRM-lenke. Misbruk kan tilbaketrekke nøkkelen.

Alternativ kortform med emails[]:

{
  "emails": ["[email protected]", "[email protected]"],
  "verifiedPurchase": false,
  "sendEmail": false
}

List opp invitasjoner og kvote

GET https://ranqa.me/api/v1/invites
Authorization: Bearer rnq_…

{
  "quota": { "used": 42, "limit": null, "remaining": null },
  "invites": [
    {
      "id": "…",
      "email": "[email protected]",
      "verifiedPurchase": true,
      "used": false,
      "expiresAt": "2026-08-15T00:00:00.000Z"
    }
  ]
}

Anmeldelser

List opp publiserte anmeldelser. Bruk nextCursor som markør for neste side.

GET https://ranqa.me/api/v1/reviews?limit=20&rating=1&target=company
Authorization: Bearer rnq_…

Spørring: limit (1–100), cursor (ISO dato), vurdering (1–5), mål (selskap|produkt).

{
  "reviews": [
    {
      "id": "…",
      "rating": 5,
      "title": null,
      "body": "Fast delivery",
      "authorName": "Anna",
      "source": "invite",
      "language": "sv",
      "createdAt": "2026-07-30T12:00:00.000Z"
    }
  ],
  "nextCursor": "2026-07-29T10:00:00.000Z"
}

Produkter

Produktsider og produktinvitasjoner krever Commerce eller Pro. POST oppretter et produkt under ditt selskap. Inkluder gtin/merke/mpn for Google-feeden.

GET https://ranqa.me/api/v1/products
Authorization: Bearer rnq_…

POST https://ranqa.me/api/v1/products
Content-Type: application/json
Authorization: Bearer rnq_…

{
  "name": "Vitamin D 90 caps",
  "sku": "VD-90",
  "externalId": "shopify-123",
  "gtin": "0735001234567",
  "brand": "Example",
  "mpn": "VD-90-MPN",
  "imageUrl": "https://cdn.example.com/vd.png"
}

Shopify & WooCommerce

HTTP-startere: pek butikkens bestillings webhook til Ranqa med en Commerce eller Pro webhook-token eller API-nøkkel.

Shopify → · WooCommerce →

POST https://ranqa.me/api/v1/commerce/shopify/orders
Authorization: Bearer rnq_…
Content-Type: application/json

{ /* Shopify order webhook JSON */ }

POST https://ranqa.me/api/v1/commerce/woocommerce/orders
Authorization: Bearer rnq_…
Content-Type: application/json

{ /* WooCommerce order webhook JSON */ }

Kartlegg Shopify product_id / Woo product_id til products.externalId slik at produktinvitasjoner lenker riktig.

Produktanmeldelser feed

Offentlig XML (Google schema 2.4) for Merchant Center planlagt henting. Opprett en token under Dashboard → API.

GET https://ranqa.me/feeds/{token}/product-reviews.xml

Roter token hvis URL-en lekker. Google godkjenner feeden separat.

Administrer API-nøkler → · Seller Ratings →

Widgets (iframe)

Ingen API-nøkkel nødvendig for innbygging — widgets er offentlige. Velg en type og valgfri produkt-slug. Snippets finnes i dashbordet.

<iframe
  src="https://ranqa.me/widget/{slug}?type=badge&size=md"
  width="280"
  height="64"
  style="border:0;overflow:hidden;border-radius:999px"
  title="RanqaScore"
  loading="lazy"
></iframe>

Typer: badge (størrelse=sm|md|lg), mini, karusell, galleri, samle, sitat. Badge er i Trustpilot-stil med Ranqa-merket. Legg til &product={slug} for en produktside (samle lenker til anmeldelser — produktvurderinger krever kjøpsinvitasjon).

https://ranqa.me/widget/{slug}?type=badge&size=sm   # email / compact
https://ranqa.me/widget/{slug}?type=badge&size=md   # website (default)
https://ranqa.me/widget/{slug}?type=badge&size=lg   # large
https://ranqa.me/widget/{slug}?type=mini
https://ranqa.me/widget/{slug}?type=carousel
https://ranqa.me/widget/{slug}?type=gallery
https://ranqa.me/widget/{slug}?type=collect
https://ranqa.me/widget/{slug}?type=quote
https://ranqa.me/widget/{slug}?type=carousel&product={productSlug}
https://ranqa.me/widget/{slug}?type=collect&product={productSlug}

Webhooks

Registrer HTTPS-endepunkter i dashbordet for signerte anrop når anmeldelser opprettes, flagges eller invitasjoner fullføres.

Hendelser du kan abonnere på:

review.created
review.flagged
invite.completed

Verifiser X-Ranqa-Signature = HMAC-SHA256 (hex) av den rå JSON-kroppen med din hemmelige nøkkel.

X-Ranqa-Signature: <hex hmac-sha256 of raw body>

{
  "type": "review.created",
  "reviewId": "…",
  "organizationId": "…",
  "rating": 2,
  "status": "published"
}

Endepunkter opprettes i dashbordet (økt), ikke via v1 API-nøkkelen.

Administrer webhooks →

Feilkoder

Svarene er JSON med et feildomene. Valideringsfeil inkluderer ofte detaljer.

401 Unauthorized — missing or invalid API key
403 Forbidden — plan/quota restriction
400 Bad Request — validation error (Zod details)
429 Too Many Requests — rate limited
500 Server error