Sdílet prostřednictvím

BlueInk

Konektor Blueink umožňuje přidat platformu Blueink eSignature do automatizovaných pracovních postupů. Konektor umožňuje zkontrolovat stav sady, vytvořit nové sady, získat přístup k informacím podepisující osoby a provádět další informace.

Tento konektor je dostupný v následujících produktech a oblastech:

Service Class Regions
Copilot Studio Premium Všechny oblasti Power Automate s výjimkou následujících:
     – státní správa USA (GCC)
     – státní správa USA (GCC High)
     - China Cloud provozovaný společností 21Vianet
     - Ministerstvo obrany USA (DoD)
Logic Apps Standard Všechny oblasti Logic Apps s výjimkou následujících:
     – Oblasti Azure Government
     – Oblasti Azure China
     - Ministerstvo obrany USA (DoD)
Power Apps Premium Všechny oblasti Power Apps s výjimkou následujících:
     – státní správa USA (GCC)
     – státní správa USA (GCC High)
     - China Cloud provozovaný společností 21Vianet
     - Ministerstvo obrany USA (DoD)
Power Automate Premium Všechny oblasti Power Automate s výjimkou následujících:
     – státní správa USA (GCC)
     – státní správa USA (GCC High)
     - China Cloud provozovaný společností 21Vianet
     - Ministerstvo obrany USA (DoD)
Kontakt
Název Podpora Blueinku
URL https://help.blueink.com/en/
Email support@blueink.com
Metadata konektoru
Vydavatel Blueink
Internetová stránka https://blueink.com
Zásady ochrany osobních údajů https://blueink.com/privacy-policy/
Kategorie Řízení podniku; Produktivita

Díky tomuto univerzálnímu konektoru můžou uživatelé bez problémů integrovat výkonné řešení eSignature blueinku do svého pracovního postupu díky využití funkcí různých konektorů Power Automate. Tato integrace umožňuje uživatelům snadno automatizovat vytváření a distribuci sad dokumentů. Orchestrací harmonické interakce tohoto konektoru s jinými konektory můžete zjednodušit procesy správy dokumentů, zvýšit efektivitu a zajistit bezproblémové a efektivní podepisování dokumentů pro vaše klienty a zúčastněné strany. Ať už jde o automatizaci schvalování smluv, zpracování právních dokumentů nebo správu papírování v jakémkoli jiném kontextu, tento konektor poskytuje výkonný nástroj pro optimalizaci pracovního postupu a zvýšení produktivity.

Požadavky

K použití tohoto konektoru budete potřebovat účet s povoleným rozhraním API z blueink.com.

Jak získat přihlašovací údaje

Po vytvoření účtu klikněte na tlačítko rozhraní API na levé straně stránky. V části Privátní klíče rozhraní API stiskněte tlačítko Přidat klíč rozhraní API . Zadejte popisek rozhraní API a stiskněte odeslat. Zkopírujte klíč rozhraní API a uložte ho někam, protože se znovu nezobrazí.

Začínáme s konektorem

Při prvním vytvoření připojení Blueink se zobrazí výzva k zadání klíče rozhraní API. Klíč rozhraní API bude vždy muset začínat tokenem následovaným mezerou a pak klíčem rozhraní API, který jste vytvořili. Zadání klíče rozhraní API by mělo vypadat jako tento klíč< rozhraní API tokenu>.

Oblíbenou akcí je vytvoření sady. Vytvoření sady vyžaduje složitou sadu vstupů. Podívejte se do naší dokumentace https://blueink.com/esignature-api/api-docs/#tag/Bundles/operation/createBundle k rozhraní API, kde najdete informace o tom, jak by proměnná těla mohla vypadat. Obrázek níže jako příklad těla vytvoření sady

Vytvoření sady

Existuje několik způsobů, jak vytvořit sadu a můžete tento json upravit tak, aby vyhovoval balíčku, který chcete vytvořit. Podívejte se na rozhraní API, kde najdete další způsoby, jak se dá tento JSON upravit. Tato šablona používá dříve vytvořenou šablonu, kterou uživatel nastavil ve svém účtu.

Výpis všech dokončených balíčků je dalším oblíbeným koncovým bodem. Přidejte akci Seznam sad a pak změňte tlačítko stavu na spolu pro dokončené sady. Pomocí tohoto koncového bodu můžete udržovat aktuální informace o všech dokončených balíčcích.

Výpis sad

Známé problémy a omezení

Pro koncový bod vytvoření sady se vyžaduje základní JSON.

Běžné chyby a nápravné prostředky

Pokud se zobrazí chyba týkající se neúspěšného požadavku s chybou neplatného tokenu, ujistěte se, že jste nezadali jenom klíč rozhraní API a včetně předchozího řetězce tokenu následovaného mezerou a pak klíčem rozhraní API.

Pokud při vytváření sady prostředků dojde k chybě týkající se neplatného vstupu, ujistěte se, že je platný JSON, který se odesílá do Blueinku.

časté otázky

1. Co je Blueink?

  • Blueink je pokročilé řešení eSignature, které zjednodušuje proces podepisování dokumentů, což usnadňuje bezpečné odesílání, podepisování a správu elektronických dokumentů.

2. Co je Konektor Microsoftu pro Blueink?

  • Microsoft Connector for Blueink je nástroj, který uživatelům umožňuje bezproblémovou integraci řešení eSignature blueinku s Microsoft Power Automate, což umožňuje automatizaci a rozšířenou správu dokumentů.

3. Jak funguje Konektor Microsoftu pro Blueink?

  • Konektor umožňuje vytvářet automatizované pracovní postupy kombinováním Blueinku s dalšími konektory Power Automate. Můžete automatizovat vytváření a distribuci sad dokumentů a rozšiřovat procesy správy dokumentů.

4. Jaké jsou případy použití konektoru Microsoft Connectoru pro Blueink?

  • Mezi běžné případy použití patří automatizace schvalování smluv, správa právních dokumentů, zjednodušení procesů papírování a zajištění bezproblémového a efektivního podepisování dokumentů pro klienty a zúčastněné strany.

5. Můžu používat Konektor Microsoftu pro Blueink s dalšími produkty Microsoftu?

  • Ano, konektor je navržený tak, aby bez problémů fungoval s různými produkty a službami Microsoftu a umožňuje integrovat blueink eSignatury do pracovních postupů orientovaných na Microsoft.

6. Je snadné nastavit a používat Konektor Microsoftu pro Blueink?

  • Ano, je uživatelsky přívětivý a navržený tak, aby byl jednoduchý. Pracovní postupy můžete nakonfigurovat a přizpůsobit tak, aby vyhovovaly vašim konkrétním potřebám správy dokumentů.

7. Souvisí s používáním konektoru Microsoft Connector pro Blueink nějaké náklady?

  • Ceny se můžou lišit v závislosti na využití a licenčních smlouvách. Nejlepší je zkontrolovat konkrétní podrobnosti o cenách u Blueinku nebo Microsoftu.

8. Můžu získat podporu pro technické problémy s Konektorem Microsoftu pro Blueink?

  • Ano, Blueink a Microsoft obvykle nabízejí zdroje podpory a dokumentaci, které vám pomůžou s technickými problémy nebo dotazy týkajícími se využití konektoru.

9. Je konektor Microsoftu pro Blueink kompatibilní s windows i cloudovými službami Microsoftu?

  • Ano, konektor je navržený tak, aby fungoval s místními i cloudovými službami Microsoftu a poskytoval flexibilitu v možnostech integrace.

10. Kde najdu další informace o konektoru Microsoft Pro Blueink?

  • Další informace, včetně průvodců nastavením a dokumentace, můžete navštívit web Blueink nebo prozkoumat dokumentaci k Microsoft Power Automate související s tímto konektorem.

Vytvoření připojení

Konektor podporuje následující typy ověřování:
výchozí Parametry pro vytvoření připojení Všechny oblasti Nesdílitelné

Výchozí

Použitelné: Všechny oblasti

Parametry pro vytvoření připojení

Toto připojení není možné sdílet. Pokud se power app sdílí s jiným uživatelem, zobrazí se výzva k explicitní vytvoření nového připojení.

Název Typ Description Povinné
Klíč rozhraní API Blueink securestring Váš klíč rozhraní BLUEINK API. Můžete ho vytvořit v Blueinku na kartě rozhraní API. Správný formát je Token XXXXXX, kde XXXXXX je váš klíč rozhraní API. Pravdivé

Limity omezování

Name Volání Období obnovení
Volání rozhraní API na připojení 100 60 sekund

Akce

Aktualizace osoby

Aktualizujte osobu novými daty. Mějte na paměti, že všechny kanály kontaktů, které nejsou z této žádosti vynechány, budou ODSTRANĚNY. Pokud nechcete nahradit všechna data v osobě, pravděpodobně chcete místo toho použít patch.
Aktualizace paketu

Aktualizace paketu (neboli podepisující osoby) novým e-mailem, telefonním číslem, jménem nebo možnostmi ověřování

Aktualizovaný paket musí být stále doručitelný. Pokud například zadáte deliver_via hodnotu "phone", ale v původním požadavku PacketRequest není nastavené žádné telefonní číslo, musí tento požadavek obsahovat phone také hodnotu nebo se vrátí chyba.

Můžete změnit paket, který byl původně nakonfigurovaný pro vložené podepisování (tj. deliver_via bylo vložení), aby se doručoval prostřednictvím e-mailu nebo SMS. Nebudou se ale automaticky odesílat žádná podpisová oznámení ani připomenutí. Pokud chcete odeslat e-mail s podpisovým oznámením (nebo SMS), musíte volat /packet/{packetId}/remind/.

Pokud je tento podepisující osoba přidružená k osobě, aktualizuje se také tato osoba – jméno osoby se změní (pokud je uvedeno) a přidá se nový e-mail nebo telefonní číslo.
Aktualizace webhooku

Aktualizujte webhook novými daty. Všimněte si, že všechna předplatná, která nejsou z této žádosti vynechána, budou ODSTRANĚNA. Pokud nechcete nahradit všechna data ve webhooku, pravděpodobně chcete místo toho použít patch.
Aktualizace webhookuExtraHeader

Aktualizace webhookuExtraHeader pomocí nových dat
Načtení certifikátu důkazů paketů

Získání odkazu a kontrolního součtu certifikátu důkazů pro tento paket
Načtení dat sady

Získání dat zadaných do polí dokončeného balíčku
Načtení osoby

Získání osoby podle ID
Načtení sady

Načtení sady pomocí slug
Načtení souborů sady

Získání souborů ke stažení pro dokončenou sadu
Načtení webhooku

Získání webhooku podle ID
Načtení webhookuExtraHeader

Načtení podrobností o webhookuExtraHeader
Načtení šablony dokumentu

Načtení šablony dokumentu
Odebrání značek ze sady

Odeberte značky ze sady prostředků. Pokud značka v požadavku v sadě neexistuje, bude ignorována.
Odeslat připomenutí

Odešlete e-mail s připomenutím nebo SMS podepisující znaménko. Připomenutí se dá odeslat jenom jednou za hodinu. Připomenutí se odešle prostřednictvím metody doručení (e-mailu nebo SMS) a na e-mailovou adresu (nebo telefonní číslo) dříve určené pro tento paket.
Odstranění osoby

Odstranění osoby Tím se odstraní také přidružený uživatel BlueInk.
Odstranění webhooku

Odstranění webhooku podle ID
Odstranění webhookuExtraHeader

Odstranění webhookuExtraHeader
Opětovné generování sdíleného tajného kódu webhooku

Opětovné vygenerujte sdílený tajný klíč webhooku.
Přidání značek do sady

Přidejte do sady další značky. V balíčku nejsou odebrány žádné existující značky. Výsledkem tohoto volání je, že Bundle.tags je sjednocení sady předchozích značek se sadou nových značek. Duplicitní značky se ignorují.
Seznam osob

Získejte seznam osob ve vašem účtu. Volitelně můžete seznam filtrovat zadáním vyhledávacího dotazu. Pokud například chcete vyhledat všechny osoby se jménem "John", použili byste dotaz search=John.
Seznam webhookůExtraHeaders

Výpis všech webhookůExtraHeaders v účtu BlueInk
Seznam šablon dokumentů

Výpis všech šablon dokumentů
Vytvoření osoby

Vytvořte novou osobu. Osoba může být přidružená k uživateli BlueInk nebo může být samostatnou osobou. Pokud chcete vytvořit osobu, která je přidružená k uživateli BlueInk, musíte toto pole zadat user_id . Pokud chcete vytvořit samostatnou osobu, musíte zadat name pole.
Vytvoření sady

Vytvoření a odeslání balíčku pro podpis
Vytvoření vložené podpisové adresy URL

Vytvoření adresy URL, kterou lze použít pro vložené podepisování
Vytvoření webhooku

Vytvoření nového webhooku
Vytvoření webhookuExtraHeader

Vytvoření nové hlavičky Webhooku
Výpis sad

Vrátí stránkovaný seznam balíčků ve vašem účtu seřazený podle data vytvoření (od nejnovějšího po nejnovější). Stránkování je možné řídit pomocí paramaterů stránkování (viz Přehled stránkování>). Filtry řetězce dotazu lze kombinovat, například /bundles/?search=Gibbons&status__in=se,co&tag=needs-attention. Při kombinování filtrů se vrátí pouze sady odpovídající všem filtrům.
Výpis událostí sady

Získání seznamu událostí přidružených k sadě
Výpis webhooků

Výpis všech webhooků v účtu BlueInk
Výpis webhookůEvents

Výpis všech událostí webhooku v účtu BlueInk
Výpis webhookůEvents

Výpis všech webhookůDeliveries v účtu BlueInk
Zrušení sady

Zrušení sady určené slugem svazku
Získání sdíleného tajného kódu Webhooku

Získání sdíleného tajného kódu Webhooku
Částečná aktualizace osoby

Částečně aktualizujte osobu novými daty.

Pokud chcete k osobě přidat nový e-mail nebo telefon, zahrňte do pole kanály kontaktchannel bez ID.

Pokud chcete aktualizovat existující contactchannel přidružený k osobě, zadejte ID. Stávající ContactChannel se aktualizuje pomocí nového e-mailu nebo telefonu. Tím se aktualizují všechny živé balíčky přidružené k osobě, která posílá tento e-mail (nebo telefon).

Pokud ContactChannel neobsahuje ID, ale e-mail (nebo telefon) odpovídá existujícímu ContactChannel, nebude tento ContactChannel změněn.
Částečné aktualizace webhooku

Částečně aktualizujte webhook novými daty.
Částečné aktualizace webhookuExtraHeader

Částečně aktualizujte WebhookExtraHeader novými daty.

Aktualizace osoby

ID operace:
updatePerson

Aktualizujte osobu novými daty. Mějte na paměti, že všechny kanály kontaktů, které nejsou z této žádosti vynechány, budou ODSTRANĚNY. Pokud nechcete nahradit všechna data v osobě, pravděpodobně chcete místo toho použít patch.

Parametry

Name Klíč Vyžadováno Typ Description
ID osoby
 personId True uuid

ID, které jednoznačně identifikuje osobu
e-mail
 email email
identifikační číslo
 id uuid
laskavý
 kind string

em pro e-mail. mp pro telefon.
telefon
 phone phone
identifikační číslo
 id uuid
is_user
 is_user boolean

Hodnota True, pokud je tato osoba přidružena k uživateli BlueInk
metadata
 metadata object

Metadata, která se mají přidružit k této osobě. Metadata se dají v SmartFillu použít k automatickému naplnění dokumentů. Podrobnosti najdete v dokumentaci SmartFill.
název
 name string

Jméno osoby

Návraty

Name Cesta Typ Description
kanály
 channels array of object
e-mail
 channels.email email
identifikační číslo
 channels.id uuid
laskavý
 channels.kind string

em pro e-mail. mp pro telefon.
telefon
 channels.phone phone
identifikační číslo
 id uuid
is_user
 is_user boolean

Hodnota True, pokud je tato osoba přidružena k uživateli BlueInk
metadata
 metadata object

Metadata, která se mají přidružit k této osobě. Metadata se dají v SmartFillu použít k automatickému naplnění dokumentů. Podrobnosti najdete v dokumentaci SmartFill.
název
 name string

Jméno osoby

Aktualizace paketu

ID operace:
updatePacket

Aktualizace paketu (neboli podepisující osoby) novým e-mailem, telefonním číslem, jménem nebo možnostmi ověřování

Aktualizovaný paket musí být stále doručitelný. Pokud například zadáte deliver_via hodnotu "phone", ale v původním požadavku PacketRequest není nastavené žádné telefonní číslo, musí tento požadavek obsahovat phone také hodnotu nebo se vrátí chyba.

Můžete změnit paket, který byl původně nakonfigurovaný pro vložené podepisování (tj. deliver_via bylo vložení), aby se doručoval prostřednictvím e-mailu nebo SMS. Nebudou se ale automaticky odesílat žádná podpisová oznámení ani připomenutí. Pokud chcete odeslat e-mail s podpisovým oznámením (nebo SMS), musíte volat /packet/{packetId}/remind/.

Pokud je tento podepisující osoba přidružená k osobě, aktualizuje se také tato osoba – jméno osoby se změní (pokud je uvedeno) a přidá se nový e-mail nebo telefonní číslo.

Parametry

Name Klíč Vyžadováno Typ Description
Slug paketů
 packetId True string

Slug, který jednoznačně identifikuje paket
body
 body

Aktualizace webhooku

ID operace:
updateWebhook

Aktualizujte webhook novými daty. Všimněte si, že všechna předplatná, která nejsou z této žádosti vynechána, budou ODSTRANĚNA. Pokud nechcete nahradit všechna data ve webhooku, pravděpodobně chcete místo toho použít patch.

Parametry

Name Klíč Vyžadováno Typ Description
ID webhooku
 webhookId True uuid

ID, které jednoznačně identifikuje webhook
enabled
 enabled boolean
event_types
 event_types array of string

typy událostí, které spustí webhook
identifikační číslo
 id uuid
název
 name string

musí dodržovat RFC 7230
pořadí
 order integer
value
 value string

musí dodržovat RFC 7230
webhook
 webhook uuid
identifikační číslo
 id uuid
JSON
 json boolean
adresa URL
 url url

by měla být úplná adresa URL, včetně http/https.

Návraty

Name Cesta Typ Description
enabled
 enabled boolean
event_types
 event_types array of string

typy událostí, které spustí webhook
extra_headers
 extra_headers array of object
identifikační číslo
 extra_headers.id uuid
název
 extra_headers.name string

musí dodržovat RFC 7230
pořadí
 extra_headers.order integer
value
 extra_headers.value string

musí dodržovat RFC 7230
webhook
 extra_headers.webhook uuid
identifikační číslo
 id uuid
JSON
 json boolean
adresa URL
 url url

by měla být úplná adresa URL, včetně http/https.

Aktualizace webhookuExtraHeader

ID operace:
updateWebhookExtraHeader

Aktualizace webhookuExtraHeader pomocí nových dat

Parametry

Name Klíč Vyžadováno Typ Description
WebhookExtraHeader ID
 webhookExtraHeaderId True uuid

ID, které jednoznačně identifikuje WebhookExtraHeader
identifikační číslo
 id uuid
název
 name string

musí dodržovat RFC 7230
pořadí
 order integer
value
 value string

musí dodržovat RFC 7230
webhook
 webhook uuid

Návraty

Name Cesta Typ Description
identifikační číslo
 id uuid
název
 name string

musí dodržovat RFC 7230
pořadí
 order integer
value
 value string

musí dodržovat RFC 7230
webhook
 webhook uuid

Načtení certifikátu důkazů paketů

ID operace:
getPacketCOE

Získání odkazu a kontrolního součtu certifikátu důkazů pro tento paket

Parametry

Name Klíč Vyžadováno Typ Description
Slug paketů
 packetId True string

Slug, který jednoznačně identifikuje paket

Načtení dat sady

ID operace:
getBundleData

Získání dat zadaných do polí dokončeného balíčku

Parametry

Name Klíč Vyžadováno Typ Description
Sada slug
 bundleSlug True string

Slug, který jednoznačně identifikuje sadu

Návraty

Name Cesta Typ Description
array of object
attachments
 attachments array of object

Pole příloh souboru pro pole přílohy nebo null
Ext
 attachments.ext string

Přípona souboru
is_image
 attachments.is_image boolean

true If this attachment file is an image
název
 attachments.name string

Název souboru přílohy
Num
 attachments.num integer

Pořadí, ve kterém byl soubor přidán, pokud existuje více nahrávek pro jedno pole přílohy (například fotka pro každou stránku dokumentu pořízenou webovou kamerou)
size
 attachments.size integer

Velikost souboru v bajtech
adresa URL
 attachments.url url

Adresa URL, kterou lze dočasně použít ke stažení souboru přílohy
doc_key
 doc_key string

Klíč jednoznačně identifikující tento dokument v sadě (z původního požadavku BundleRequest)
field_key
 field_key string

Klíč jednoznačně identifikující pole v dokumentu (jak je uvedeno v původním DocumentRequestField v DocumentRequestField v BundleRequest, nebo nakonfigurované na DocumentTemplate)
filled_by
 filled_by string

Klíč paketu podepisující osoby, která zadala hodnotu pro toto pole. Pokud hodnota pole nebyla "initial_value" upravena podepisovačem, hodnota je "initial". Pokud byla hodnota pole výchozí hodnotou nakonfigurovanou pro DocumentTemplate, výplň je výchozí.
laskavý
 kind string

Druh pole
jmenovka
 label string

Popisek pole (pravděpodobně prázdný)
packet_id
 packet_id

ID paketu podepisující osoby, která zadala hodnotu pro toto pole, nebo null, pokud hodnota pole nebyla vyplněna podepisující osoby (tj. byla to initial_value nebo defaul hodnota).
value
 value

Hodnota pole.

Načtení osoby

ID operace:
getPerson

Získání osoby podle ID

Parametry

Name Klíč Vyžadováno Typ Description
ID osoby
 personId True uuid

ID, které jednoznačně identifikuje osobu

Návraty

Name Cesta Typ Description
kanály
 channels array of object
e-mail
 channels.email email
identifikační číslo
 channels.id uuid
laskavý
 channels.kind string

em pro e-mail. mp pro telefon.
telefon
 channels.phone phone
identifikační číslo
 id uuid
is_user
 is_user boolean

Hodnota True, pokud je tato osoba přidružena k uživateli BlueInk
metadata
 metadata object

Metadata, která se mají přidružit k této osobě. Metadata se dají v SmartFillu použít k automatickému naplnění dokumentů. Podrobnosti najdete v dokumentaci SmartFill.
název
 name string

Jméno osoby

Načtení sady

ID operace:
retrieveBundle

Načtení sady pomocí slug

Parametry

Name Klíč Vyžadováno Typ Description
Sada slug
 bundleSlug True string

Slug, který jednoznačně identifikuje sadu

Načtení souborů sady

ID operace:
getBundleFiles

Získání souborů ke stažení pro dokončenou sadu

Parametry

Name Klíč Vyžadováno Typ Description
Sada slug
 bundleSlug True string

Slug, který jednoznačně identifikuje sadu

Návraty

Name Cesta Typ Description
array of object
propadává
 expires string

Čas, kdy platnost propojení vyprší, jako formátovaný čas ISO 8601
file_url
 file_url string

adresa URL, ze které lze soubor stáhnout

Načtení webhooku

ID operace:
getWebhook

Získání webhooku podle ID

Parametry

Name Klíč Vyžadováno Typ Description
ID webhooku
 webhookId True uuid

ID, které jednoznačně identifikuje webhook

Návraty

Name Cesta Typ Description
enabled
 enabled boolean
event_types
 event_types array of string

typy událostí, které spustí webhook
extra_headers
 extra_headers array of object
identifikační číslo
 extra_headers.id uuid
název
 extra_headers.name string

musí dodržovat RFC 7230
pořadí
 extra_headers.order integer
value
 extra_headers.value string

musí dodržovat RFC 7230
webhook
 extra_headers.webhook uuid
identifikační číslo
 id uuid
JSON
 json boolean
adresa URL
 url url

by měla být úplná adresa URL, včetně http/https.

Načtení webhookuExtraHeader

ID operace:
getWebhookExtraHeader

Načtení podrobností o webhookuExtraHeader

Parametry

Name Klíč Vyžadováno Typ Description
WebhookExtraHeader ID
 webhookExtraHeaderId True uuid

ID, které jednoznačně identifikuje WebhookExtraHeader

Návraty

Name Cesta Typ Description
identifikační číslo
 id uuid
název
 name string

musí dodržovat RFC 7230
pořadí
 order integer
value
 value string

musí dodržovat RFC 7230
webhook
 webhook uuid

Načtení šablony dokumentu

ID operace:
retrieveTemplate

Načtení šablony dokumentu

Parametry

Name Klíč Vyžadováno Typ Description
ID šablony
 templateId True uuid

ID, které jedinečně identifikuje šablonu

Návraty

Name Cesta Typ Description
pole
 fields array of

Pole polí umístěných v dokumentu. Všimněte si, že pole DocumentTemplate se mírně liší od polí DocumentRequest, která mají default_value místo editor_rolesinitial_value a editors.
file_url
 file_url string

Adresa URL původního souboru, který slouží jako základ pro tuto šablonu
is_shared
 is_shared boolean

Hodnota True, pokud je šablona dokumentu sdílena. Jinak False
název
 name string

Název dokumentu. Ve výchozím nastavení se název souboru nebo dokument při nahrání nastaví na popisný název člověka.
roles
 roles array of object
klíč
 roles.key string

Řetězec, který je jedinečný pro tento dokument, který identifikuje tuto roli
jmenovka
 roles.label string

Popisek pro tuto roli přívětivý pro člověka

Odebrání značek ze sady

ID operace:
removeBundleTags

Odeberte značky ze sady prostředků. Pokud značka v požadavku v sadě neexistuje, bude ignorována.

Parametry

Name Klíč Vyžadováno Typ Description
Sada slug
 bundleSlug True string

Slug, který jednoznačně identifikuje sadu
tags
 tags array of string

Pole značek

Odeslat připomenutí

ID operace:
sendPacketReminder

Odešlete e-mail s připomenutím nebo SMS podepisující znaménko. Připomenutí se dá odeslat jenom jednou za hodinu. Připomenutí se odešle prostřednictvím metody doručení (e-mailu nebo SMS) a na e-mailovou adresu (nebo telefonní číslo) dříve určené pro tento paket.

Parametry

Name Klíč Vyžadováno Typ Description
Slug paketů
 packetId True string

Slug, který jednoznačně identifikuje paket

Odstranění osoby

ID operace:
deletePerson

Odstranění osoby Tím se odstraní také přidružený uživatel BlueInk.

Parametry

Name Klíč Vyžadováno Typ Description
ID osoby
 personId True uuid

ID, které jednoznačně identifikuje osobu

Odstranění webhooku

ID operace:
deleteWebhook

Odstranění webhooku podle ID

Parametry

Name Klíč Vyžadováno Typ Description
ID webhooku
 webhookId True uuid

ID, které jednoznačně identifikuje webhook

Odstranění webhookuExtraHeader

ID operace:
deleteWebhookExtraHeader

Odstranění webhookuExtraHeader

Parametry

Name Klíč Vyžadováno Typ Description
WebhookExtraHeader ID
 webhookExtraHeaderId True uuid

ID, které jednoznačně identifikuje WebhookExtraHeader

Opětovné generování sdíleného tajného kódu webhooku

ID operace:
regenerateWebhookSecret

Opětovné vygenerujte sdílený tajný klíč webhooku.

Návraty

Name Cesta Typ Description
create_date
 create_date date-time
tajný klíč
 secret b58

Přidání značek do sady

ID operace:
addBundleTags

Přidejte do sady další značky. V balíčku nejsou odebrány žádné existující značky. Výsledkem tohoto volání je, že Bundle.tags je sjednocení sady předchozích značek se sadou nových značek. Duplicitní značky se ignorují.

Parametry

Name Klíč Vyžadováno Typ Description
Sada slug
 bundleSlug True string

Slug, který jednoznačně identifikuje sadu
tags
 tags array of string

Pole značek

Seznam osob

ID operace:
listPersons

Získejte seznam osob ve vašem účtu. Volitelně můžete seznam filtrovat zadáním vyhledávacího dotazu. Pokud například chcete vyhledat všechny osoby se jménem "John", použili byste dotaz search=John.

Parametry

Name Klíč Vyžadováno Typ Description
Vyhledávací dotaz
 search string

Vyhledávací dotaz.

Návraty

Name Cesta Typ Description
array of object
kanály
 channels array of object
e-mail
 channels.email email
identifikační číslo
 channels.id uuid
laskavý
 channels.kind string

em pro e-mail. mp pro telefon.
telefon
 channels.phone phone
identifikační číslo
 id uuid
is_user
 is_user boolean

Hodnota True, pokud je tato osoba přidružena k uživateli BlueInk
metadata
 metadata object

Metadata, která se mají přidružit k této osobě. Metadata se dají v SmartFillu použít k automatickému naplnění dokumentů. Podrobnosti najdete v dokumentaci SmartFill.
název
 name string

Jméno osoby

Seznam webhookůExtraHeaders

ID operace:
listWebhookExtraHeaders

Výpis všech webhookůExtraHeaders v účtu BlueInk

Parametry

Name Klíč Vyžadováno Typ Description
ID webhooku
 webhook uuid

Vrátí se pouze WebhookExtraHeaders odpovídající vybranému ID webhooku.

Např. /webhooks/headers/?webhook=a053644f-e371-4883-ac17-534445993346
Typ události
 event_type string

Vrátí se pouze WebhookExtraHeaders s webhooky odpovídající vybraným event_type nebo event_types.

Např. /webhooks/headers/?event_type=bundle_sent/webhooks/headers/?event_type__in=bundle_error,bundle_cancelled

Návraty

Name Cesta Typ Description
array of object
identifikační číslo
 id uuid
název
 name string

musí dodržovat RFC 7230
pořadí
 order integer
value
 value string

musí dodržovat RFC 7230
webhook
 webhook uuid

Seznam šablon dokumentů

ID operace:
listTemplates

Výpis všech šablon dokumentů

Návraty

Name Cesta Typ Description
pole
 fields array of

Pole polí umístěných v dokumentu. Všimněte si, že pole DocumentTemplate se mírně liší od polí DocumentRequest, která mají default_value místo editor_rolesinitial_value a editors.
file_url
 file_url string

Adresa URL původního souboru, který slouží jako základ pro tuto šablonu
is_shared
 is_shared boolean

Hodnota True, pokud je šablona dokumentu sdílena. Jinak False
název
 name string

Název dokumentu. Ve výchozím nastavení se název souboru nebo dokument při nahrání nastaví na popisný název člověka.
roles
 roles array of object
klíč
 roles.key string

Řetězec, který je jedinečný pro tento dokument, který identifikuje tuto roli
jmenovka
 roles.label string

Popisek pro tuto roli přívětivý pro člověka

Vytvoření osoby

ID operace:
createPerson

Vytvořte novou osobu. Osoba může být přidružená k uživateli BlueInk nebo může být samostatnou osobou. Pokud chcete vytvořit osobu, která je přidružená k uživateli BlueInk, musíte toto pole zadat user_id . Pokud chcete vytvořit samostatnou osobu, musíte zadat name pole.

Parametry

Name Klíč Vyžadováno Typ Description
e-mail
 email email
identifikační číslo
 id uuid
laskavý
 kind string

em pro e-mail. mp pro telefon.
telefon
 phone phone
identifikační číslo
 id uuid
is_user
 is_user boolean

Hodnota True, pokud je tato osoba přidružena k uživateli BlueInk
metadata
 metadata object

Metadata, která se mají přidružit k této osobě. Metadata se dají v SmartFillu použít k automatickému naplnění dokumentů. Podrobnosti najdete v dokumentaci SmartFill.
název
 name string

Jméno osoby

Návraty

Name Cesta Typ Description
kanály
 channels array of object
e-mail
 channels.email email
identifikační číslo
 channels.id uuid
laskavý
 channels.kind string

em pro e-mail. mp pro telefon.
telefon
 channels.phone phone
identifikační číslo
 id uuid
is_user
 is_user boolean

Hodnota True, pokud je tato osoba přidružena k uživateli BlueInk
metadata
 metadata object

Metadata, která se mají přidružit k této osobě. Metadata se dají v SmartFillu použít k automatickému naplnění dokumentů. Podrobnosti najdete v dokumentaci SmartFill.
název
 name string

Jméno osoby

Vytvoření sady

ID operace:
createBundle

Vytvoření a odeslání balíčku pro podpis

Parametry

Name Klíč Vyžadováno Typ Description
body
 body

Tělo JSON, které definuje balíček, který se má vytvořit

Vytvoření vložené podpisové adresy URL

ID operace:
createPacketEmbedURL

Vytvoření adresy URL, kterou lze použít pro vložené podepisování

Parametry

Name Klíč Vyžadováno Typ Description
Slug paketů
 packetId True string

Slug, který jednoznačně identifikuje paket

Návraty

Name Cesta Typ Description
propadává
 expires date-time

Časové razítko označující vypršení platnosti adresy URL
adresa URL
 url string

Adresa URL, ve které se dá použít pro vložené podepisování

Vytvoření webhooku

ID operace:
createWebhook

Vytvoření nového webhooku

Parametry

Name Klíč Vyžadováno Typ Description
enabled
 enabled boolean
event_types
 event_types array of string

typy událostí, které spustí webhook
identifikační číslo
 id uuid
název
 name string

musí dodržovat RFC 7230
pořadí
 order integer
value
 value string

musí dodržovat RFC 7230
webhook
 webhook uuid
identifikační číslo
 id uuid
JSON
 json boolean
adresa URL
 url url

by měla být úplná adresa URL, včetně http/https.

Návraty

Name Cesta Typ Description
enabled
 enabled boolean
event_types
 event_types array of string

typy událostí, které spustí webhook
extra_headers
 extra_headers array of object
identifikační číslo
 extra_headers.id uuid
název
 extra_headers.name string

musí dodržovat RFC 7230
pořadí
 extra_headers.order integer
value
 extra_headers.value string

musí dodržovat RFC 7230
webhook
 extra_headers.webhook uuid
identifikační číslo
 id uuid
JSON
 json boolean
adresa URL
 url url

by měla být úplná adresa URL, včetně http/https.

Vytvoření webhookuExtraHeader

ID operace:
createWebhookExtraHeader

Vytvoření nové hlavičky Webhooku

Parametry

Name Klíč Vyžadováno Typ Description
identifikační číslo
 id uuid
název
 name string

musí dodržovat RFC 7230
pořadí
 order integer
value
 value string

musí dodržovat RFC 7230
webhook
 webhook uuid

Návraty

Name Cesta Typ Description
identifikační číslo
 id uuid
název
 name string

musí dodržovat RFC 7230
pořadí
 order integer
value
 value string

musí dodržovat RFC 7230
webhook
 webhook uuid

Výpis sad

ID operace:
listBundles

Vrátí stránkovaný seznam balíčků ve vašem účtu seřazený podle data vytvoření (od nejnovějšího po nejnovější). Stránkování je možné řídit pomocí paramaterů stránkování (viz Přehled stránkování>). Filtry řetězce dotazu lze kombinovat, například /bundles/?search=Gibbons&status__in=se,co&tag=needs-attention. Při kombinování filtrů se vrátí pouze sady odpovídající všem filtrům.

Parametry

Name Klíč Vyžadováno Typ Description
Vyhledávací dotaz
 search string

Vyhledávací dotaz. Vrátí se pouze sady odpovídající hledání. Prohledávají se následující data v balíčku:

  • sada slug
  • popisek balíčku
  • custom_key sady
  • jméno podepisující osoby
  • e-mail podepisující osoby
  • podepisující telefony

Např. /bundles/?search=foobar@example.com
Stav sady
 status string

Omezte balíčky na ty se zadaným stavem.

  • dr: Koncept - Sada ještě nebyla odeslána
  • se: Odesláno - sada byla odeslána, ale ještě nebyla spuštěna žádnými podepisujícími
  • st: Spuštěno – aspoň jeden podepisující se začal kontrolovat dokumenty.
  • co: Dokončeno – všichni podepisující osoby dokončily kontrolu / podepisování
  • ca: Zrušeno – sada byla zrušena.
  • např.: Vypršela platnost sady před dokončením
  • fa: Selhalo – došlo k chybě a balíček nelze vytvořit nebo dokončit.

Např. /bundles/?status=co
Seznam stavu balíčku
 status__in string

Omezte balíčky na ty, které mají jeden ze zadaných stavů. Stavy by měly být oddělené čárkami. Např. /bundles/?status=co,se,st
Značka balíčku
 tag string

Vrátí balíčky, které mají danou značku. Např. /bundles/?tag=some-tag
Seznam značek balíčků
 tag__in string

Vrátí balíčky, které mají aspoň jednu z daných značek. Značky by měly být oddělené čárkami. Např. /bundles/?tag=some-tag,another-tag
Pořadí řazení sady
 ordering string

Řídí pořadí řazení sad. Předpona "-" pro obrácení pořadí řazení Ve výchozím nastavení jsou sady seřazené podle "-created", tj. datum vytvoření sady od nejnovějšího po nejnovější.

Návraty

Name Cesta Typ Description
array of

Výpis událostí sady

ID operace:
listBundleEvents

Získání seznamu událostí přidružených k sadě

Parametry

Name Klíč Vyžadováno Typ Description
Sada slug
 bundleSlug True string

Slug, který jednoznačně identifikuje sadu

Návraty

Name Cesta Typ Description
array of object
popis
 description string

Stručný popis události
laskavý
 kind string

Druh události jako kód se 2 znaky
packet_id
 packet_id uuid

UUID paketu. Prezentovat pouze v případě, že je událost přidružena k určitému paketu.
časové razítko
 timestamp date-time

Čas, kdy došlo k události

Výpis webhooků

ID operace:
listWebhooks

Výpis všech webhooků v účtu BlueInk

Parametry

Name Klíč Vyžadováno Typ Description
Enabled
 enabled boolean

Vrátí se pouze webhooky odpovídající vybranému stavu Povoleno.

Např. /webhooks/?enabled=true
Typ události
 event_type string

Vrátí se pouze webhooky odpovídající vybranému event_type nebo event_types.

Např. /webhooks/?event_type=bundle_sent/webhooks/?event_type__in=bundle_error,bundle_cancelled

Návraty

Name Cesta Typ Description
array of object
enabled
 enabled boolean
event_types
 event_types array of string

typy událostí, které spustí webhook
extra_headers
 extra_headers array of object
identifikační číslo
 extra_headers.id uuid
název
 extra_headers.name string

musí dodržovat RFC 7230
pořadí
 extra_headers.order integer
value
 extra_headers.value string

musí dodržovat RFC 7230
webhook
 extra_headers.webhook uuid
identifikační číslo
 id uuid
JSON
 json boolean
adresa URL
 url url

by měla být úplná adresa URL, včetně http/https.

Výpis webhookůEvents

ID operace:
listWebhookEvents

Výpis všech událostí webhooku v účtu BlueInk

Parametry

Name Klíč Vyžadováno Typ Description
ID webhooku
 webhook uuid

Vrátí se pouze webhookEvents odpovídající vybranému ID webhooku.

Např. /webhooks/events/?webhook=a053644f-e371-4883-ac17-534445993346
Typ události
 event_type string

Vrátí se pouze webhookEventy s webhooky odpovídající vybraným event_type nebo event_types.

Např. /webhooks/events/?event_type=bundle_sent/webhooks/events/?event_type__in=bundle_error,bundle_cancelled
Stav
 status integer

Vrátí se pouze webhookEvents odpovídající vybranému stavu.

Např. /webhooks/events/?status=1/webhooks/events/?status__in=0,1,2
Výsledek úspěchu
 success boolean

Vrátí se pouze webhookEvents odpovídající vybranému stavu úspěchu.

Např. /webhooks/events/?success=true
Časové období
 date date-time

Vrátí se pouze události WebhookEvent, ke kterým dochází mezi rozsahem kalendářních dat. Poznámka: Kalendářní data jsou vyjádřena ve formátu RRRR-MM-DD.

Např. /webhooks/events/?date_after=2022-10-01&date_before=2022-10-31

Návraty

Name Cesta Typ Description
array of object
vytvořil
 created date-time
dodávky
 deliveries array of object
zpráva
 deliveries.message string

zpráva popisující všechny problémy
Pk
 deliveries.pk uuid
stav
 deliveries.status integer

stavová zpráva odpovědi nebo 0, pokud žádný stav neexistuje
časové razítko
 deliveries.timestamp date-time

pokud došlo k pokusu o doručení (začátek pokusu, ne v případě selhání, např. vypršení časového limitu)
event_type
 event_type string
datová část
 payload string

datovou část, která má být odeslána při doručení; json
Pk
 pk uuid
stav
 status integer

stavový kód poslední odpovědi z koncového bodu webhooku. 0 znamená, že nebyla přijata žádná odpověď.
úspěch
 success boolean
webhook
 webhook uuid

Identifikátor UUID určující, do kterého webhooku událost patří

Výpis webhookůEvents

ID operace:
listWebhookDeliveries

Výpis všech webhookůDeliveries v účtu BlueInk

Parametry

Name Klíč Vyžadováno Typ Description
ID webhooku
 webhook uuid

Vrátí se pouze WebhookDeliveries odpovídající vybranému ID webhooku.

Např. /webhooks/deliveries/?webhook=a053644f-e371-4883-ac17-534445993346
ID události Webhooku
 webhook_event uuid

Vrátí se pouze WebhookDeliveries odpovídající vybranému ID webhook_event.

Např. /webhooks/deliveries/?webhook_event=a053644f-e371-4883-ac17-534445993346
Typ události
 event_type string

Vrátí se pouze WebhookDeliveries s webhooky odpovídající vybraným event_type nebo event_types.

Např. /webhooks/deliveries/?event_type=bundle_sent/webhooks/deliveries/?event_type__in=bundle_error,bundle_cancelled
Stav
 status integer

Vrátí se pouze WebhookDeliveries odpovídající vybranému stavu.

Např. /webhooks/deliveries/?status=1/webhooks/deliveries/?status__in=0,1,2
Časové období
 date date-time

Vrátí se pouze webhookDeliveries, ke kterým dochází mezi rozsahem kalendářních dat. Poznámka: Kalendářní data jsou vyjádřena ve formátu RRRR-MM-DD.

Např. /webhooks/deliveries/?date_after=2022-10-01&date_before=2022-10-31

Návraty

Name Cesta Typ Description
array of object
vytvořil
 created date-time
dodávky
 deliveries array of object
zpráva
 deliveries.message string

zpráva popisující všechny problémy
Pk
 deliveries.pk uuid
stav
 deliveries.status integer

stavová zpráva odpovědi nebo 0, pokud žádný stav neexistuje
časové razítko
 deliveries.timestamp date-time

pokud došlo k pokusu o doručení (začátek pokusu, ne v případě selhání, např. vypršení časového limitu)
event_type
 event_type string
datová část
 payload string

datovou část, která má být odeslána při doručení; json
Pk
 pk uuid
stav
 status integer

stavový kód poslední odpovědi z koncového bodu webhooku. 0 znamená, že nebyla přijata žádná odpověď.
úspěch
 success boolean
webhook
 webhook uuid

Identifikátor UUID určující, do kterého webhooku událost patří

Zrušení sady

ID operace:
cancelBundle

Zrušení sady určené slugem svazku

Parametry

Name Klíč Vyžadováno Typ Description
Sada slug
 bundleSlug True string

Slug, který jednoznačně identifikuje sadu

Získání sdíleného tajného kódu Webhooku

ID operace:
getWebhookSecret

Získání sdíleného tajného kódu Webhooku

Návraty

Name Cesta Typ Description
create_date
 create_date date-time
tajný klíč
 secret b58

Částečná aktualizace osoby

ID operace:
updatePersonPartial

Částečně aktualizujte osobu novými daty.

Pokud chcete k osobě přidat nový e-mail nebo telefon, zahrňte do pole kanály kontaktchannel bez ID.

Pokud chcete aktualizovat existující contactchannel přidružený k osobě, zadejte ID. Stávající ContactChannel se aktualizuje pomocí nového e-mailu nebo telefonu. Tím se aktualizují všechny živé balíčky přidružené k osobě, která posílá tento e-mail (nebo telefon).

Pokud ContactChannel neobsahuje ID, ale e-mail (nebo telefon) odpovídá existujícímu ContactChannel, nebude tento ContactChannel změněn.

Parametry

Name Klíč Vyžadováno Typ Description
ID osoby
 personId True uuid

ID, které jednoznačně identifikuje osobu
e-mail
 email email
identifikační číslo
 id uuid
laskavý
 kind string

em pro e-mail. mp pro telefon.
telefon
 phone phone
identifikační číslo
 id uuid
is_user
 is_user boolean

Hodnota True, pokud je tato osoba přidružena k uživateli BlueInk
metadata
 metadata object

Metadata, která se mají přidružit k této osobě. Metadata se dají v SmartFillu použít k automatickému naplnění dokumentů. Podrobnosti najdete v dokumentaci SmartFill.
název
 name string

Jméno osoby

Návraty

Name Cesta Typ Description
kanály
 channels array of object
e-mail
 channels.email email
identifikační číslo
 channels.id uuid
laskavý
 channels.kind string

em pro e-mail. mp pro telefon.
telefon
 channels.phone phone
identifikační číslo
 id uuid
is_user
 is_user boolean

Hodnota True, pokud je tato osoba přidružena k uživateli BlueInk
metadata
 metadata object

Metadata, která se mají přidružit k této osobě. Metadata se dají v SmartFillu použít k automatickému naplnění dokumentů. Podrobnosti najdete v dokumentaci SmartFill.
název
 name string

Jméno osoby

Částečné aktualizace webhooku

ID operace:
updateWebhookartial

Částečně aktualizujte webhook novými daty.

Parametry

Name Klíč Vyžadováno Typ Description
ID webhooku
 webhookId True uuid

ID, které jednoznačně identifikuje webhook
enabled
 enabled boolean
event_types
 event_types array of string

typy událostí, které spustí webhook
identifikační číslo
 id uuid
název
 name string

musí dodržovat RFC 7230
pořadí
 order integer
value
 value string

musí dodržovat RFC 7230
webhook
 webhook uuid
identifikační číslo
 id uuid
JSON
 json boolean
adresa URL
 url url

by měla být úplná adresa URL, včetně http/https.

Návraty

Name Cesta Typ Description
enabled
 enabled boolean
event_types
 event_types array of string

typy událostí, které spustí webhook
extra_headers
 extra_headers array of object
identifikační číslo
 extra_headers.id uuid
název
 extra_headers.name string

musí dodržovat RFC 7230
pořadí
 extra_headers.order integer
value
 extra_headers.value string

musí dodržovat RFC 7230
webhook
 extra_headers.webhook uuid
identifikační číslo
 id uuid
JSON
 json boolean
adresa URL
 url url

by měla být úplná adresa URL, včetně http/https.

Částečné aktualizace webhookuExtraHeader

ID operace:
updateWebhookExtraHeaderPartial

Částečně aktualizujte WebhookExtraHeader novými daty.

Parametry

Name Klíč Vyžadováno Typ Description
WebhookExtraHeader ID
 webhookExtraHeaderId True uuid

ID, které jednoznačně identifikuje WebhookExtraHeader
identifikační číslo
 id uuid
název
 name string

musí dodržovat RFC 7230
pořadí
 order integer
value
 value string

musí dodržovat RFC 7230
webhook
 webhook uuid

Návraty

Name Cesta Typ Description
identifikační číslo
 id uuid
název
 name string

musí dodržovat RFC 7230
pořadí
 order integer
value
 value string

musí dodržovat RFC 7230
webhook
 webhook uuid