Dokumentace API

Vizuální integrace ve vaší aplikaci

Zobrazte stav Peppol přímo vedle informací o společnosti (název, IČ, fakturační profil), aby uživatelé mohli ověřit připravenost příjemce na první pohled.

Můžete také přidat affiliateId (získáte v aplikaci) a zapojit se do affiliate programu.

Náhled widgetů

micro

mini

small

large

Varianty

  • micro: pouze ikona, minimální místo v přehledných tabulkách.
  • mini: ikona + popisek, kompaktní pro řádky seznamu.
  • small: doporučená výchozí varianta u názvu firmy, po najetí myší zobrazí detail.
  • large: plná karta s detaily pro sekce profilu.

Velký náhled

Varianta large obsahuje podrobné registrační informace a hodí se pro profilové karty.

Shrnutí chování

  • Použijte jeden sdílený tag script pro libovolný počet widgetů na stránce.
  • Zavolejte pepposhShowBadge pro každý cíl s požadovanou variantou.
  • Kliknutí na widget otevře detail na https://app.pepposch.eu/lookup/{peppolId}.

Parametry a povolené hodnoty

  • countryCode: dvoupísmenný kód země, například CZ.
  • rn: IČ firmy.
  • euVatId: volitelné DIČ v EU, například CZ05574617.
  • peppolId: volitelné přímé vyhledání Peppol ID, například 5599:123.
  • affiliateId: volitelný affiliate identifikátor vašeho účtu, například afp_123456.
  • targetId: ID DOM prvku, do kterého se widget vykreslí.
  • variant: micro, mini, small, large.
  • loading: show (výchozí), hide, space.
    show = animovaný zástupný prvek (large zobrazí kompaktní načítací kartu), space = průhledná vyhrazená oblast.
  • error: show (výchozí), hide, space.
  • registered: show (výchozí), hide, space.
  • unregistered: show (výchozí), hide, space.

Příklad použití (jeden widget)

<div id="partner-peppol-badge"></div>

<script src="https://look.pepposh.eu/cdn/peppol-badge.js"></script>
<script>
  pepposhShowBadge({
    countryCode: "CZ",
    rn: "05574617",
    affiliateId: "afp_123456",
    targetId: "partner-peppol-badge",
    variant: "small",
    loading: "show",
    error: "show",
    registered: "show",
    unregistered: "show"
  })
</script>

Příklad použití (peppolId)

<div id="partner-peppol-id-badge"></div>

<script src="https://look.pepposh.eu/cdn/peppol-badge.js"></script>
<script>
  pepposhShowBadge({
    peppolId: "5599:123",
    affiliateId: "afp_123456",
    targetId: "partner-peppol-id-badge",
    variant: "mini"
  })
</script>

Příklad použití (micro)

<div id="badge-micro"></div>

<script src="https://look.pepposh.eu/cdn/peppol-badge.js"></script>
<script>
  pepposhShowBadge({
    countryCode: "CZ",
    rn: "12345678",
    targetId: "badge-micro",
    variant: "micro"
  })
</script>

Příklad použití (mini)

<div id="badge-mini"></div>

<script src="https://look.pepposh.eu/cdn/peppol-badge.js"></script>
<script>
  pepposhShowBadge({
    countryCode: "CZ",
    rn: "12345678",
    targetId: "badge-mini",
    variant: "mini"
  })
</script>

Příklad použití (small)

<div id="badge-small"></div>

<script src="https://look.pepposh.eu/cdn/peppol-badge.js"></script>
<script>
  pepposhShowBadge({
    euVatId: "CZ12345678",
    targetId: "badge-small",
    variant: "small"
  })
</script>

Příklad použití (large)

<div id="badge-large"></div>

<script src="https://look.pepposh.eu/cdn/peppol-badge.js"></script>
<script>
  pepposhShowBadge({
    countryCode: "CZ",
    rn: "12345678",
    targetId: "badge-large",
    variant: "large"
  })
</script>