RichPear HOME DOCS Začít

Integrace RichPear Home

AfterShip

Integrace AfterShip připojí cloudovou službu pro sledování zásilek a vytvoří souhrnný senzor balíků, které ještě nejsou ve stavu Delivered. Senzor se hodí pro dashboard i upozornění na rozpracované doručování.

Začít nastaveníZpět na audit
Doména
aftership
Kategorie
Doručování
Komunikace
cloud-polling
Požadavek
AfterShip Pro API
01

Připravte AfterShip účet a API klíč

Pro integraci potřebujete účet AfterShip a API klíč z administrační stránky AfterShip API. RichPear Home při nastavení ověří klíč dotazem na seznam sledování, takže nestačí jen libovolný textový token.

AfterShip odstranil Tracking API z plánu Forever Free a nenabízí ho ani v plánu Essentials. Pro použití integrace je potřeba minimálně plán Pro.

Co mít předem

  1. AfterShip účet s aktivním plánem, který zahrnuje Tracking API.
  2. API klíč z části AfterShip API v administraci služby.
  3. V účtu vytvořené nebo připravené zásilky, pokud chcete po připojení hned vidět praktická data.
  4. Slug dopravce pro ruční mazání zásilek, například identifikátor dopravce používaný v AfterShip API.
02

Vyberte integraci AfterShip

V RichPear Home otevřete Nastavení → Zařízení a služby, klikněte na Přidat integraci a vyhledejte AfterShip.

Výběr AfterShip v dialogu Přidat integraci.
03

Vložte API klíč

Do pole Klíč API vložte klíč z administrace AfterShip a odešlete formulář. RichPear Home se připojí k veřejnému REST API AfterShip a po úspěšném ověření vytvoří jednu položku integrace.

Pokud odeslání selže, zkontrolujte, že klíč patří k účtu s dostupným Tracking API. Bez plánu Pro průvodce reálně nedokončíte.

Český formulář AfterShip vyžaduje pouze API klíč.
04

Zkontrolujte senzor zásilek

Integrace vytváří senzor, jehož hodnota je počet zásilek, které nejsou ve stavu Delivered. Doručené zásilky se do hodnoty senzoru nepočítají.

Atributy senzoru obsahují počty zásilek podle jednotlivých stavů a seznam sledování. U každé položky se ukládá například název nebo číslo zásilky, slug dopravce, odkaz na sledování, poslední aktualizace, očekávané doručení, stav a poslední checkpoint.

Praktické použití senzoru

  1. Na dashboard přidejte hlavní senzor AfterShip jako počet rozpracovaných zásilek.
  2. Pro detailní přehled používejte atribut trackings, pokud ho chcete zpracovat šablonou.
  3. Po změně zásilek počítejte s cloudovým dotazováním; běžné obnovení probíhá přibližně v intervalu 15 minut.
  4. Doručené zásilky sledujte v atributech podle statusů, ne podle hlavní hodnoty senzoru.
05

Použijte akce pro přidání a odebrání sledování

AfterShip přidává dvě akce. aftership.add_tracking přidá nové sledování do AfterShip a aftership.remove_tracking sledování odebere.

U přidání je povinné pouze tracking_number. Pole slug pro dopravce a title pro vlastní název jsou volitelná. U odebrání jsou povinné tracking_number i slug.

Dostupné akce

  1. aftership.add_tracking: tracking_number povinně, slug a title volitelně.
  2. aftership.remove_tracking: tracking_number a slug povinně.
06

Otestujte akce ručně

Než akce použijete v automatizaci, spusťte je ručně ve vývojářských nástrojích nebo v jednoduchém skriptu. U dopravce používejte slug podle AfterShip, ne jen marketingový název dopravce.

Příklad přidání zásilky

action: aftership.add_tracking
data:
  tracking_number: "123456789"
  slug: "fedex"
  title: "Notebook"
07

Odeberte sledování podle čísla a dopravce

Pro odebrání nestačí samotné číslo zásilky. AfterShip akce vyžaduje také slug, protože stejné číslo může dávat smysl u více dopravců.

Příklad odebrání zásilky

action: aftership.remove_tracking
data:
  tracking_number: "123456789"
  slug: "fedex"
08

Řešení problémů

Pokud se integrace nepřipojí, nejdřív ověřte API klíč přímo v administraci AfterShip a zkontrolujte plán účtu. Chyba připojení při nastavování typicky znamená, že RichPear Home nedokáže přes API získat seznam sledování.

Integrace používá veřejné REST API AfterShip, ale není se službou AfterShip oficiálně spojená. Při výpadku API nebo změně oprávnění účtu proto zkontrolujte stav služby a limity na straně AfterShip.

Časté příčiny

  1. Plán účtu: Forever Free ani Essentials nestačí pro Tracking API.
  2. API klíč: klíč je neplatný, zrušený nebo nepatří ke správnému účtu.
  3. Dopravce: při odebrání sledování chybí správný slug.
  4. Stav senzoru: hlavní hodnota nezahrnuje zásilky ve stavu Delivered.
Při neplatném API klíči průvodce zůstane otevřený a zobrazí chybu Nepodařilo se připojit.
URL

Lokální adresa systému

RichPear Home se v domácí síti běžně otevírá na http://rphome.local:8123. Pokud tato adresa v dané síti neodpoví, použijte http://IP-ADRESA:8123.