Poštár

Dokumentace API

Komponenta pro vyhledávání v adresáři pro statické webové stránky

Tuto komponentu použijte, když chcete vložit vyhledávání v adresáři Peppol do prosté stránky HTML bez vytváření vlastní aplikace React.

Skript CDN připojí prvek iframe do vašeho cílového prvku, projde vaším affiliateId a automaticky udržuje výšku rámce synchronizovanou.

Živý náhled

Tento náhled používá stejný veřejný zavaděč CDN, jaký bude používat vaše statická stránka.

Rychlý start

<!-- 1. Place a target container on your static page -->
<div id="peppol-search-widget"></div>

<!-- 2. Load the widget loader -->
<script src="https://look.pepposh.eu/cdn/peppol-search.js"></script>

<!-- 3. Mount the search widget -->
<script>
  pepposhShowSearch({
    targetId: "peppol-search-widget",
    affiliateId: "YOUR-AFFILIATE-UUID"
  });
</script>

Automatická inicializace značky skriptu

Pro jeden widget na stránce můžete přeskočit další vložený skript a nakonfigurovat zavaděč pomocí atributů dat.

<!-- Static page with one widget -->
<div id="peppol-search-widget"></div>

<script
  src="https://look.pepposh.eu/cdn/peppol-search.js"
  data-target="peppol-search-widget"
  data-affiliate-id="YOUR-AFFILIATE-UUID"
></script>

Parametry

FieldRequiredDescription
targetIdyes*ID of the container element where the iframe should be mounted.
affiliateIdrecommendedAffiliate UUID used for public lookup attribution and rate-limiting protection.
appBasenoBase URL of the Peppol app. Defaults to https://look.pepposh.eu.
heightnoInitial iframe height in pixels before the embedded page reports its measured height.
target / targetSelectoralternativeUse one of these instead of targetId when you prefer passing a DOM node or CSS selector.

* Use exactly one of targetId, target, or targetSelector.

Pokročilý příklad

pepposhShowSearch({
  targetId: "peppol-search-widget",
  affiliateId: "YOUR-AFFILIATE-UUID",

  // Optional when self-hosting or using another environment
  appBase: "https://look.pepposh.eu",

  // Optional initial iframe height in pixels
  height: 720,
});

Poznámky k chování

  • Widget je izolován uvnitř prvku iframe, takže jej lze použít ze statických stránek bez sdružování poskytovatelů React, Tailwind nebo aplikací.
  • Žádosti o vyhledávání a odkazy na výsledky automaticky zahrnují affiliateId, když je poskytnete.
  • Zavaděč nahradí aktuální obsah cílového prvku prvkem iframe.
  • Pokud potřebujete přímější integraci rozhraní API, použijte koncové body vyhledávání namísto hotové komponenty.

Související: Reference koncového bodu vyhledávání a způsoby autorizace.

Produkční adresy URL

  • CDN loader: https://look.pepposh.eu/cdn/peppol-search.js
  • Embedded page: https://look.pepposh.eu/embed/peppol-search
Otevřete nezpracovanou vloženou stránku