Udostępnij przez

BlueInk

Łącznik Blueink umożliwia dodanie platformy eSignature rozwiązania Blueink do zautomatyzowanych przepływów pracy. Łącznik umożliwia sprawdzanie stanu pakietu, tworzenie nowych pakietów, uzyskiwanie dostępu do informacji o podpisywaniu i nie tylko.

Ten łącznik jest dostępny w następujących produktach i regionach:

Usługa Class Regions
Copilot Studio Premium Wszystkie regiony usługi Power Automate z wyjątkiem następujących:
     - Rząd USA (GCC)
     - Rząd USA (GCC High)
     - China Cloud obsługiwane przez firmę 21Vianet
     - Departament Obrony USA (DoD)
Logic Apps Standard Wszystkie regiony usługi Logic Apps z wyjątkiem następujących:
     — Regiony platformy Azure Government
     — Regiony platformy Azure (Chiny)
     - Departament Obrony USA (DoD)
Power Apps Premium Wszystkie regiony usługi Power Apps z wyjątkiem następujących:
     - Rząd USA (GCC)
     - Rząd USA (GCC High)
     - China Cloud obsługiwane przez firmę 21Vianet
     - Departament Obrony USA (DoD)
Power Automate Premium Wszystkie regiony usługi Power Automate z wyjątkiem następujących:
     - Rząd USA (GCC)
     - Rząd USA (GCC High)
     - China Cloud obsługiwane przez firmę 21Vianet
     - Departament Obrony USA (DoD)
Kontakt
Name Obsługa rozwiązania Blueink
adres URL https://help.blueink.com/en/
Email support@blueink.com
Metadane łącznika
Publisher Blueink
Witryna internetowa https://blueink.com
Zasady ochrony prywatności https://blueink.com/privacy-policy/
Kategorie Zarządzanie biznesem; Produktywność

Dzięki temu uniwersalnemu łącznikowi użytkownicy mogą bezproblemowo zintegrować zaawansowane rozwiązanie eSignature rozwiązania Blueink z przepływem pracy dzięki wykorzystaniu możliwości różnych łączników usługi Power Automate. Dzięki tej integracji użytkownicy mogą bez wysiłku zautomatyzować tworzenie i dystrybucję pakietów dokumentów. Organizując harmonijną interakcję tego łącznika z innymi łącznikami, możesz usprawnić procesy zarządzania dokumentami, zwiększyć wydajność i zapewnić bezproblemowe i wydajne środowisko podpisywania dokumentów dla klientów i uczestników projektu. Niezależnie od tego, czy automatyzuje zatwierdzenia kontraktów, przetwarza dokumenty prawne, czy zarządza dokumentami w innym kontekście, ten łącznik udostępnia zaawansowane narzędzie do optymalizowania przepływu pracy i zwiększania produktywności.

Wymagania wstępne

Aby korzystać z tego łącznika, musisz mieć konto z obsługą interfejsu API z poziomu blueink.com.

Jak uzyskać poświadczenia

Po utworzeniu konta kliknij przycisk interfejsu API po lewej stronie. W obszarze Klucze prywatnego interfejsu API naciśnij przycisk Dodaj klucz interfejsu API . Nadaj interfejsu API etykietę i naciśnij przycisk Prześlij. Skopiuj klucz interfejsu API i zapisz go gdzieś, ponieważ nie zostanie on ponownie wyświetlony.

Wprowadzenie do łącznika

Podczas pierwszego tworzenia połączenia Blueink zostanie wyświetlony monit o wprowadzenie klucza interfejsu API. Klucz interfejsu API zawsze musi rozpoczynać się od tokenu , po którym następuje spacja, a następnie utworzony klucz interfejsu API. Wprowadzanie klucza interfejsu API powinno wyglądać następująco: klucz> interfejsu API tokenu<.

Popularną akcją jest utworzenie pakietu. Tworzenie pakietu wymaga złożonego zestawu danych wejściowych. Zapoznaj się z naszą dokumentacją interfejsu API, aby https://blueink.com/esignature-api/api-docs/#tag/Bundles/operation/createBundle dowiedzieć się, jak może wyglądać zmienna treść. Obraz poniżej jako przykład treści tworzenia pakietu.

Untitled

Istnieje wiele sposobów tworzenia pakietu i można zmodyfikować ten kod JSON zgodnie z pakietem, który chcesz utworzyć. Zapoznaj się z interfejsem API, aby uzyskać więcej sposobów modyfikacji tego kodu JSON. W tym celu użyto wcześniej utworzonego szablonu skonfigurowanego przez użytkownika na swoim koncie.

Wyświetlenie listy wszystkich ukończonych pakietów jest kolejnym popularnym punktem końcowym. Dodaj akcję Pakiety listy, a następnie zmień przycisk stanu na co dla ukończonych pakietów. Możesz być na bieżąco ze wszystkimi najnowszymi ukończonymi pakietami przy użyciu tego punktu końcowego.

Untitled

Znane problemy i ograniczenia

Treść JSON jest wymagana dla punktu końcowego tworzenia pakietu

Typowe błędy i środki zaradcze

Jeśli zostanie wyświetlony błąd dotyczący żądania, które nie powiodło się z powodu nieprawidłowego błędu tokenu, upewnij się, że nie wklejono klucza interfejsu API w pliku i dołączenie poprzedniego ciągu tokenu , po którym następuje spacja, a następnie klucz interfejsu API.

Jeśli podczas tworzenia pakietu wystąpi błąd dotyczący nieprawidłowych danych wejściowych, upewnij się, że jest to prawidłowy kod JSON wysyłany do rozwiązania Blueink.

Często zadawane pytania

1. Co to jest Blueink?

  • Blueink to zaawansowane rozwiązanie eSignature, które upraszcza proces podpisywania dokumentów, co ułatwia bezpieczne wysyłanie i podpisywanie dokumentów elektronicznych oraz zarządzanie nimi.

2. Co to jest łącznik firmy Microsoft dla rozwiązania Blueink?

  • Microsoft Connector for Blueink to narzędzie, które umożliwia użytkownikom bezproblemową integrację rozwiązania eSignature rozwiązania Blueink z usługą Microsoft Power Automate, co umożliwia automatyzację i ulepszone zarządzanie dokumentami.

3. Jak działa łącznik Firmy Microsoft dla rozwiązania Blueink?

  • Łącznik umożliwia tworzenie zautomatyzowanych przepływów pracy przez połączenie rozwiązania Blueink z innymi łącznikami usługi Power Automate. Można zautomatyzować tworzenie i dystrybucję pakietów dokumentów, zwiększając procesy zarządzania dokumentami.

4. Jakie są przypadki użycia łącznika firmy Microsoft dla rozwiązania Blueink?

  • Typowe przypadki użycia obejmują automatyzowanie zatwierdzeń kontraktów, zarządzanie dokumentami prawnymi, usprawnianie procesów papierowych oraz zapewnienie bezproblemowego i wydajnego środowiska podpisywania dokumentów dla klientów i uczestników projektu.

5. Czy mogę użyć łącznika firmy Microsoft dla rozwiązania Blueink z innymi produktami firmy Microsoft?

  • Tak, łącznik został zaprojektowany tak, aby bezproblemowo współdziałał z różnymi produktami i usługami firmy Microsoft, umożliwiając integrację rozwiązania Blueink eSignatures z przepływami pracy skoncentrowanymi na firmie Microsoft.

6. Czy łącznik firmy Microsoft dla rozwiązania Blueink jest łatwy do skonfigurowania i użycia?

  • Tak, jest przyjazny dla użytkownika i zaprojektowany tak, aby był prosty. Przepływy pracy można konfigurować i dostosowywać do określonych potrzeb związanych z zarządzaniem dokumentami.

7. Czy istnieją jakieś koszty związane z używaniem łącznika firmy Microsoft dla rozwiązania Blueink?

  • Ceny mogą się różnić w zależności od użycia i umów licencyjnych. Najlepiej sprawdzić usługę Blueink lub Microsoft, aby uzyskać szczegółowe informacje o cenach.

8. Czy mogę uzyskać pomoc techniczną dotyczącą problemów technicznych z łącznikiem firmy Microsoft dla rozwiązania Blueink?

  • Tak, blueink i firma Microsoft zwykle oferują zasoby pomocy technicznej i dokumentację, aby pomóc w wszelkich problemach technicznych lub pytaniach, które mogą być związane z użyciem łącznika.

9. Czy łącznik firmy Microsoft dla rozwiązania Blueink jest zgodny zarówno z usługami firmy Microsoft opartymi na systemie Windows, jak i w chmurze?

  • Tak, łącznik jest przeznaczony do pracy z lokalnymi i opartymi na chmurze usługami firmy Microsoft, zapewniając elastyczność opcji integracji.

10. Gdzie mogę znaleźć więcej informacji o łączniku firmy Microsoft dla rozwiązania Blueink?

  • Aby uzyskać dodatkowe informacje, w tym przewodniki konfiguracji i dokumentację, możesz odwiedzić witrynę internetową Blueink lub zapoznać się z dokumentacją usługi Microsoft Power Automate związaną z tym łącznikiem.

Tworzenie połączenia

Łącznik obsługuje następujące typy uwierzytelniania:
Wartość domyślna Parametry tworzenia połączenia. Wszystkie regiony Nie można udostępniać

Domyślny

Dotyczy: wszystkie regiony

Parametry tworzenia połączenia.

Nie jest to możliwe do udostępnienia połączenie. Jeśli aplikacja power zostanie udostępniona innemu użytkownikowi, zostanie wyświetlony monit o jawne utworzenie nowego połączenia.

Name Typ Description Wymagane
Klucz interfejsu API Blueink securestring Klucz interfejsu API Blueink. Można to utworzyć w rozwiązaniu Blueink na karcie Interfejs API. Poprawny format to "Token XXXXXX", w którym XXXXXX jest kluczem interfejsu API Prawda

Limity ograniczania

Nazwa Wywołania Okres odnowienia
Wywołania interfejsu API na połączenie 100 60 sekund

Akcje

Aktualizowanie elementu webhook

Zaktualizuj element webhook przy użyciu nowych danych. PAMIĘTAJ, że wszystkie subskrypcje pominięte w tym żądaniu zostaną USUNIĘTE. Jeśli nie chcesz zastępować wszystkich danych elementu webhook, prawdopodobnie chcesz użyć poprawki PATCH.
Aktualizowanie elementu WebhookExtraHeader

Aktualizowanie elementu WebhookExtraHeader przy użyciu nowych danych
Aktualizowanie osoby

Zaktualizuj osobę przy użyciu nowych danych. Należy pamiętać, że wszystkie kanały kontaktowe pominięte w tym żądaniu zostaną USUNIĘTE. Jeśli nie chcesz zastępować wszystkich danych osoby, prawdopodobnie chcesz użyć poprawki PATCH.
Aktualizowanie pakietu

Aktualizowanie pakietu (czyli osoby podpisającego) przy użyciu nowych opcji poczty e-mail, numeru telefonu, nazwy lub uwierzytelniania

Zaktualizowany pakiet musi być nadal dostarczany. Jeśli na przykład określisz wartość "phone", ale w oryginalnym elemecie deliver_via PacketRequest nie ustawiono numeru telefonu, to żądanie musi również zawierać phone wartość lub zostanie zwrócony błąd.

Możesz zmienić pakiet, który został pierwotnie skonfigurowany do podpisywania osadzonego (czyli deliver_via był "osadzony" do dostarczenia za pośrednictwem poczty e-mail lub wiadomości SMS. Jednak żadne powiadomienia ani przypomnienia dotyczące podpisywania nie będą wysyłane automatycznie. Musisz wywołać /packet/{packetId}/przypomnieć/, aby wysłać wiadomość e-mail z powiadomieniem podpisywania (lub SMS).

Jeśli ten użytkownik jest skojarzony z osobą, osoba zostanie również zaktualizowana — imię i nazwisko osoby zostanie zmienione (jeśli podano) i zostanie dodany nowy adres e-mail lub numer telefonu.
Anulowanie pakietu

Anulowanie pakietu określonego przez usługę Bundle Slug
Częściowe aktualizowanie elementu webhook

Częściowo zaktualizuj element webhook przy użyciu nowych danych.
Częściowo aktualizuj osobę

Częściowo zaktualizuj osobę przy użyciu nowych danych.

Aby dodać nową wiadomość e-mail lub telefon do osoby, dołącz element ContactChannel do tablicy "kanały" bez identyfikatora.

Aby zaktualizować istniejący contactChannel skojarzony z osobą, dołącz element "id". Istniejący kanał ContactChannel zostanie zaktualizowany przy użyciu nowej wiadomości e-mail lub telefonu. Spowoduje to zaktualizowanie wszystkich pakietów na żywo skojarzonych z osobą, która wysyła do tej wiadomości e-mail (lub telefonu).

Jeśli element ContactChannel nie zawiera identyfikatora, ale wiadomość e-mail (lub telefon) jest zgodna z istniejącym kanałem ContactChannel, nie zostanie zmieniony.
Częściowo zaktualizuj element WebhookExtraHeader

Częściowo zaktualizuj element WebhookExtraHeader przy użyciu nowych danych.
Dodawanie tagów do pakietu

Dodaj dodatkowe tagi do pakietu. Żadne istniejące tagi w pakiecie nie są usuwane. Wynikiem tego wywołania jest to, że bundle.tags jest połączeniem zestawu poprzednich tagów z zestawem nowych tagów. Zduplikowane tagi są ignorowane.
Lista osób

Pobierz listę osób na twoim koncie. Możesz opcjonalnie filtrować listę, podając zapytanie wyszukiwania. Aby na przykład wyszukać wszystkie osoby o nazwie "Jan", użyj zapytania search=John.
Listy pakietów

Zwraca listę pakietów podzielonych na strony na koncie uporządkowaną według daty utworzenia (od najnowszej do najnowszej). Stronicowanie można kontrolować za pomocą paramaterów stronicowania (zobacz Omówienie—>stronicowanie). Parametry parametrów filtrów zapytań można łączyć, np. /bundles/?search=Gibbons&status__in=se,co&tag=needs-attention. Podczas łączenia filtrów zwracane są tylko pakiety pasujące do wszystkich filtrów.
Pobieranie certyfikatu pakietu dowodów

Pobierz link i sumę kontrolną certyfikatu dowodów dla tego pakietu
Pobieranie danych pakietu

Pobieranie danych wprowadzonych w polach dla ukończonego pakietu
Pobieranie elementu webhook

Pobieranie elementu webhook według identyfikatora
Pobieranie elementu WebhookExtraHeader

Pobieranie szczegółów elementu WebhookExtraHeader
Pobieranie osoby

Pobieranie osoby według identyfikatora
Pobieranie pakietu

Pobieranie pakietu przez slug
Pobieranie plików pakietu

Pobieranie plików do pobrania dla ukończonego pakietu
Pobieranie szablonu dokumentu

Pobieranie szablonu dokumentu
Ponowne generowanie udostępnionego wpisu tajnego elementu webhook

Ponowne generowanie udostępnionego wpisu tajnego elementu webhook
Tworzenie elementu webhook

Tworzenie nowego elementu webhook
Tworzenie elementu WebhookExtraHeader

Tworzenie nowego nagłówka elementu webhook
Tworzenie osadzonego adresu URL podpisywania

Tworzenie adresu URL, który może służyć do podpisywania osadzonego
Tworzenie osoby

Utwórz nową osobę. Osoba może być skojarzona z użytkownikiem BlueInk lub może być osobą autonomiczną. Jeśli chcesz utworzyć osobę skojarzona z użytkownikiem BlueInk, musisz podać user_id pole. Jeśli chcesz utworzyć autonomiczną osobę, musisz podać name pole.
Tworzenie pakietu

Tworzenie i wysyłanie pakietu na potrzeby podpisu
Usuwanie elementu webhook

Usuwanie elementu webhook według identyfikatora
Usuwanie elementu WebhookExtraHeader

Usuwanie elementu WebhookExtraHeader
Usuwanie osoby

Usuń osobę. Spowoduje to również usunięcie wszystkich skojarzonych użytkowników rozwiązania BlueInk.
Usuwanie tagów z pakietu

Usuwanie tagów z pakietu. Jeśli tag w żądaniu nie istnieje w pakiecie, zostanie zignorowany.
Uzyskiwanie udostępnionego wpisu tajnego elementu webhook

Uzyskiwanie udostępnionego wpisu tajnego elementu webhook
Wysyłanie przypomnienia

Wyślij wiadomość e-mail z przypomnieniem lub wiadomość SMS do sygnatariusza. Przypomnienie można wysyłać tylko raz na godzinę. Przypomnienie zostanie wysłane za pośrednictwem metody dostarczania (wiadomości e-mail lub wiadomości SMS) oraz do adresu e-mail (lub numeru telefonu) wyznaczonego wcześniej dla tego pakietu.
Wyświetlanie listy elementów webhook

Wyświetlanie listy wszystkich elementów webhook na koncie BlueInk
Wyświetlanie listy elementów webhookEvent

Wyświetlanie listy wszystkich zdarzeń elementu webhook na koncie BlueInk
Wyświetlanie listy elementów webhookEvent

Wyświetlanie listy wszystkich elementów webhookDeliveries na koncie BlueInk
Wyświetlanie listy elementów webhookExtraHeaders

Wyświetlanie listy wszystkich elementów WebhookExtraHeaders na koncie BlueInk
Wyświetlanie listy szablonów dokumentów

Wyświetlanie listy wszystkich szablonów dokumentów
Wyświetlanie listy zdarzeń pakietu

Pobieranie listy zdarzeń skojarzonych z pakietem

Aktualizowanie elementu webhook

Identyfikator operacji:
updateWebhook

Zaktualizuj element webhook przy użyciu nowych danych. PAMIĘTAJ, że wszystkie subskrypcje pominięte w tym żądaniu zostaną USUNIĘTE. Jeśli nie chcesz zastępować wszystkich danych elementu webhook, prawdopodobnie chcesz użyć poprawki PATCH.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator elementu webhook
 webhookId True uuid

Identyfikator, który jednoznacznie identyfikuje element webhook
enabled
 enabled boolean
event_types
 event_types array of string

typy zdarzeń, które będą uruchamiać element webhook
id
 id uuid
nazwa
 name string

musi być zgodny z RFC 7230
porządek
 order integer
value
 value string

musi być zgodny z RFC 7230
element webhook
 webhook uuid
id
 id uuid
JSON
 json boolean
URL
 url url

powinien być pełnym adresem URL, w tym http/https

Zwraca

Nazwa Ścieżka Typ Opis
enabled
 enabled boolean
event_types
 event_types array of string

typy zdarzeń, które będą uruchamiać element webhook
extra_headers
 extra_headers array of object
id
 extra_headers.id uuid
nazwa
 extra_headers.name string

musi być zgodny z RFC 7230
porządek
 extra_headers.order integer
value
 extra_headers.value string

musi być zgodny z RFC 7230
element webhook
 extra_headers.webhook uuid
id
 id uuid
JSON
 json boolean
URL
 url url

powinien być pełnym adresem URL, w tym http/https

Aktualizowanie elementu WebhookExtraHeader

Identyfikator operacji:
updateWebhookExtraHeader

Aktualizowanie elementu WebhookExtraHeader przy użyciu nowych danych

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator elementu webhookExtraHeader
 webhookExtraHeaderId True uuid

Identyfikator, który jednoznacznie identyfikuje element WebhookExtraHeader
id
 id uuid
nazwa
 name string

musi być zgodny z RFC 7230
porządek
 order integer
value
 value string

musi być zgodny z RFC 7230
element webhook
 webhook uuid

Zwraca

Nazwa Ścieżka Typ Opis
id
 id uuid
nazwa
 name string

musi być zgodny z RFC 7230
porządek
 order integer
value
 value string

musi być zgodny z RFC 7230
element webhook
 webhook uuid

Aktualizowanie osoby

Identyfikator operacji:
updatePerson

Zaktualizuj osobę przy użyciu nowych danych. Należy pamiętać, że wszystkie kanały kontaktowe pominięte w tym żądaniu zostaną USUNIĘTE. Jeśli nie chcesz zastępować wszystkich danych osoby, prawdopodobnie chcesz użyć poprawki PATCH.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator osoby
 personId True uuid

Identyfikator, który jednoznacznie identyfikuje osobę
e-mail
 email email
id
 id uuid
rodzaj
 kind string

em na adres e-mail. mp dla telefonu.
phone
 phone phone
id
 id uuid
is_user
 is_user boolean

Prawda, jeśli ta osoba jest skojarzona z użytkownikiem BlueInk
metadane
 metadata object

Metadane do skojarzenia z tą osobą. Metadane mogą być używane w funkcji SmartFill do automatycznego wypełniania dokumentów. Aby uzyskać szczegółowe informacje, zobacz dokumentację smartfill.
nazwa
 name string

Imię i nazwisko osoby

Zwraca

Nazwa Ścieżka Typ Opis
Kanały
 channels array of object
e-mail
 channels.email email
id
 channels.id uuid
rodzaj
 channels.kind string

em na adres e-mail. mp dla telefonu.
phone
 channels.phone phone
id
 id uuid
is_user
 is_user boolean

Prawda, jeśli ta osoba jest skojarzona z użytkownikiem BlueInk
metadane
 metadata object

Metadane do skojarzenia z tą osobą. Metadane mogą być używane w funkcji SmartFill do automatycznego wypełniania dokumentów. Aby uzyskać szczegółowe informacje, zobacz dokumentację smartfill.
nazwa
 name string

Imię i nazwisko osoby

Aktualizowanie pakietu

Identyfikator operacji:
updatePacket

Aktualizowanie pakietu (czyli osoby podpisającego) przy użyciu nowych opcji poczty e-mail, numeru telefonu, nazwy lub uwierzytelniania

Zaktualizowany pakiet musi być nadal dostarczany. Jeśli na przykład określisz wartość "phone", ale w oryginalnym elemecie deliver_via PacketRequest nie ustawiono numeru telefonu, to żądanie musi również zawierać phone wartość lub zostanie zwrócony błąd.

Możesz zmienić pakiet, który został pierwotnie skonfigurowany do podpisywania osadzonego (czyli deliver_via był "osadzony" do dostarczenia za pośrednictwem poczty e-mail lub wiadomości SMS. Jednak żadne powiadomienia ani przypomnienia dotyczące podpisywania nie będą wysyłane automatycznie. Musisz wywołać /packet/{packetId}/przypomnieć/, aby wysłać wiadomość e-mail z powiadomieniem podpisywania (lub SMS).

Jeśli ten użytkownik jest skojarzony z osobą, osoba zostanie również zaktualizowana — imię i nazwisko osoby zostanie zmienione (jeśli podano) i zostanie dodany nowy adres e-mail lub numer telefonu.

Parametry

Nazwa Klucz Wymagane Typ Opis
Pakiet Slug
 packetId True string

Slug, który jednoznacznie identyfikuje pakiet
body
 body

Anulowanie pakietu

Identyfikator operacji:
cancelBundle

Anulowanie pakietu określonego przez usługę Bundle Slug

Parametry

Nazwa Klucz Wymagane Typ Opis
Pakiet Slug
 bundleSlug True string

Slug, który jednoznacznie identyfikuje pakiet

Częściowe aktualizowanie elementu webhook

Identyfikator operacji:
updateWebhookartial

Częściowo zaktualizuj element webhook przy użyciu nowych danych.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator elementu webhook
 webhookId True uuid

Identyfikator, który jednoznacznie identyfikuje element webhook
enabled
 enabled boolean
event_types
 event_types array of string

typy zdarzeń, które będą uruchamiać element webhook
id
 id uuid
nazwa
 name string

musi być zgodny z RFC 7230
porządek
 order integer
value
 value string

musi być zgodny z RFC 7230
element webhook
 webhook uuid
id
 id uuid
JSON
 json boolean
URL
 url url

powinien być pełnym adresem URL, w tym http/https

Zwraca

Nazwa Ścieżka Typ Opis
enabled
 enabled boolean
event_types
 event_types array of string

typy zdarzeń, które będą uruchamiać element webhook
extra_headers
 extra_headers array of object
id
 extra_headers.id uuid
nazwa
 extra_headers.name string

musi być zgodny z RFC 7230
porządek
 extra_headers.order integer
value
 extra_headers.value string

musi być zgodny z RFC 7230
element webhook
 extra_headers.webhook uuid
id
 id uuid
JSON
 json boolean
URL
 url url

powinien być pełnym adresem URL, w tym http/https

Częściowo aktualizuj osobę

Identyfikator operacji:
updatePersonPartial

Częściowo zaktualizuj osobę przy użyciu nowych danych.

Aby dodać nową wiadomość e-mail lub telefon do osoby, dołącz element ContactChannel do tablicy "kanały" bez identyfikatora.

Aby zaktualizować istniejący contactChannel skojarzony z osobą, dołącz element "id". Istniejący kanał ContactChannel zostanie zaktualizowany przy użyciu nowej wiadomości e-mail lub telefonu. Spowoduje to zaktualizowanie wszystkich pakietów na żywo skojarzonych z osobą, która wysyła do tej wiadomości e-mail (lub telefonu).

Jeśli element ContactChannel nie zawiera identyfikatora, ale wiadomość e-mail (lub telefon) jest zgodna z istniejącym kanałem ContactChannel, nie zostanie zmieniony.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator osoby
 personId True uuid

Identyfikator, który jednoznacznie identyfikuje osobę
e-mail
 email email
id
 id uuid
rodzaj
 kind string

em na adres e-mail. mp dla telefonu.
phone
 phone phone
id
 id uuid
is_user
 is_user boolean

Prawda, jeśli ta osoba jest skojarzona z użytkownikiem BlueInk
metadane
 metadata object

Metadane do skojarzenia z tą osobą. Metadane mogą być używane w funkcji SmartFill do automatycznego wypełniania dokumentów. Aby uzyskać szczegółowe informacje, zobacz dokumentację smartfill.
nazwa
 name string

Imię i nazwisko osoby

Zwraca

Nazwa Ścieżka Typ Opis
Kanały
 channels array of object
e-mail
 channels.email email
id
 channels.id uuid
rodzaj
 channels.kind string

em na adres e-mail. mp dla telefonu.
phone
 channels.phone phone
id
 id uuid
is_user
 is_user boolean

Prawda, jeśli ta osoba jest skojarzona z użytkownikiem BlueInk
metadane
 metadata object

Metadane do skojarzenia z tą osobą. Metadane mogą być używane w funkcji SmartFill do automatycznego wypełniania dokumentów. Aby uzyskać szczegółowe informacje, zobacz dokumentację smartfill.
nazwa
 name string

Imię i nazwisko osoby

Częściowo zaktualizuj element WebhookExtraHeader

Identyfikator operacji:
updateWebhookExtraHeaderPartial

Częściowo zaktualizuj element WebhookExtraHeader przy użyciu nowych danych.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator elementu webhookExtraHeader
 webhookExtraHeaderId True uuid

Identyfikator, który jednoznacznie identyfikuje element WebhookExtraHeader
id
 id uuid
nazwa
 name string

musi być zgodny z RFC 7230
porządek
 order integer
value
 value string

musi być zgodny z RFC 7230
element webhook
 webhook uuid

Zwraca

Nazwa Ścieżka Typ Opis
id
 id uuid
nazwa
 name string

musi być zgodny z RFC 7230
porządek
 order integer
value
 value string

musi być zgodny z RFC 7230
element webhook
 webhook uuid

Dodawanie tagów do pakietu

Identyfikator operacji:
addBundleTags

Dodaj dodatkowe tagi do pakietu. Żadne istniejące tagi w pakiecie nie są usuwane. Wynikiem tego wywołania jest to, że bundle.tags jest połączeniem zestawu poprzednich tagów z zestawem nowych tagów. Zduplikowane tagi są ignorowane.

Parametry

Nazwa Klucz Wymagane Typ Opis
Pakiet Slug
 bundleSlug True string

Slug, który jednoznacznie identyfikuje pakiet
tags
 tags array of string

Tablica tagów

Lista osób

Identyfikator operacji:
listPersons

Pobierz listę osób na twoim koncie. Możesz opcjonalnie filtrować listę, podając zapytanie wyszukiwania. Aby na przykład wyszukać wszystkie osoby o nazwie "Jan", użyj zapytania search=John.

Parametry

Nazwa Klucz Wymagane Typ Opis
Kwerenda wyszukiwania
 search string

Zapytanie wyszukiwania.

Zwraca

Nazwa Ścieżka Typ Opis
array of object
Kanały
 channels array of object
e-mail
 channels.email email
id
 channels.id uuid
rodzaj
 channels.kind string

em na adres e-mail. mp dla telefonu.
phone
 channels.phone phone
id
 id uuid
is_user
 is_user boolean

Prawda, jeśli ta osoba jest skojarzona z użytkownikiem BlueInk
metadane
 metadata object

Metadane do skojarzenia z tą osobą. Metadane mogą być używane w funkcji SmartFill do automatycznego wypełniania dokumentów. Aby uzyskać szczegółowe informacje, zobacz dokumentację smartfill.
nazwa
 name string

Imię i nazwisko osoby

Listy pakietów

Identyfikator operacji:
listBundles

Zwraca listę pakietów podzielonych na strony na koncie uporządkowaną według daty utworzenia (od najnowszej do najnowszej). Stronicowanie można kontrolować za pomocą paramaterów stronicowania (zobacz Omówienie—>stronicowanie). Parametry parametrów filtrów zapytań można łączyć, np. /bundles/?search=Gibbons&status__in=se,co&tag=needs-attention. Podczas łączenia filtrów zwracane są tylko pakiety pasujące do wszystkich filtrów.

Parametry

Nazwa Klucz Wymagane Typ Opis
Kwerenda wyszukiwania
 search string

Zapytanie wyszukiwania. Zostaną zwrócone tylko pakiety pasujące do wyszukiwania. Przeszukiwane są następujące dane w pakiecie:

  • slug pakietu
  • etykieta pakietu
  • custom_key pakietu
  • nazwa osoby podpisającego
  • adres e-mail sygnatariusza
  • telefony do logowania

Np. /bundles/?search=foobar@example.com
Stan pakietu
 status string

Ogranicz pakiety do tych z określonym stanem.

  • dr: Wersja robocza — pakiet nie został jeszcze wysłany
  • se: Wysłane — pakiet został wysłany, ale nie został jeszcze uruchomiony przez żadnych sygnatariuszy
  • st: Rozpoczęto — co najmniej jeden użytkownik podpisujący rozpoczął przeglądanie dokumentów
  • co: Ukończono — wszystkie osoby podpisujące zakończyły przeglądanie/podpisywanie
  • ca: Anulowano — pakiet został anulowany
  • na przykład: Wygasło — pakiet wygasł przed jego ukończeniem
  • fa: Niepowodzenie — wystąpił błąd i nie można utworzyć ani ukończyć pakietu

Np. /bundles/?status=co
Lista stanu pakietu
 status__in string

Ogranicz pakiety do tych z jednym z określonych stanów. Stany powinny być rozdzielone przecinkami. Np. /bundles/?status=co,se,st
Tag pakietu
 tag string

Zwracaj pakiety, które mają dany tag. Np. /bundles/?tag=some-tag
Lista tagów pakietów
 tag__in string

Zwraca pakiety, które mają co najmniej jeden z podanych tagów. Tagi powinny być rozdzielone przecinkami. Np. /bundles/?tag=some-tag,another-tag
Kolejność sortowania pakietu
 ordering string

Kontrolowanie kolejności sortowania pakietów. Prefiks z ciągiem "-" w celu odwrócenia kolejności sortowania. Domyślnie pakiety są sortowane według wartości "-created", czyli daty utworzenia pakietu od najnowszej do najnowszej.

Zwraca

Nazwa Ścieżka Typ Opis
array of

Pobieranie certyfikatu pakietu dowodów

Identyfikator operacji:
getPacketCOE

Pobierz link i sumę kontrolną certyfikatu dowodów dla tego pakietu

Parametry

Nazwa Klucz Wymagane Typ Opis
Pakiet Slug
 packetId True string

Slug, który jednoznacznie identyfikuje pakiet

Pobieranie danych pakietu

Identyfikator operacji:
getBundleData

Pobieranie danych wprowadzonych w polach dla ukończonego pakietu

Parametry

Nazwa Klucz Wymagane Typ Opis
Pakiet Slug
 bundleSlug True string

Slug, który jednoznacznie identyfikuje pakiet

Zwraca

Nazwa Ścieżka Typ Opis
array of object
attachments
 attachments array of object

Tablica załączników plików dla pola załącznika lub wartości null
Ext
 attachments.ext string

Rozszerzenie pliku
is_image
 attachments.is_image boolean

wartość true, jeśli ten plik załącznika jest obrazem
nazwa
 attachments.name string

Nazwa pliku załącznika
Num
 attachments.num integer

Kolejność, w jakiej plik został dodany, jeśli istnieje wiele przekazywania dla jednego pola załącznika (na przykład zdjęcie dla każdej strony dokumentu zrobionej z kamerą internetową)
size
 attachments.size integer

Rozmiar pliku w bajtach
URL
 attachments.url url

Adres URL, którego można tymczasowo użyć do pobrania pliku załącznika
doc_key
 doc_key string

Klucz jednoznacznie identyfikujący ten dokument w pakiecie (z oryginalnego elementu BundleRequest)
field_key
 field_key string

Klucz jednoznacznie identyfikujący pole w dokumencie (zgodnie z wartością określoną w oryginalnym polu DocumentRequestField w polu DocumentRequest w pliku BundleRequest lub zgodnie z konfiguracją elementu DocumentTemplate)
filled_by
 filled_by string

Klucz pakietu użytkownika podpisujący, który wprowadził wartość dla tego pola. Jeśli wartość pola była wartością "initial_value", która nie została edytowana przez znakatora, wartość to "initial". Jeśli wartość pola była wartością domyślną skonfigurowaną w dokumencieTemplate, wypełnienie ma wartość domyślną.
rodzaj
 kind string

Rodzaj pola
etykieta
 label string

Etykieta pola (prawdopodobnie pusta)
packet_id
 packet_id

Identyfikator pakietu osoby podpisającego, która wprowadziła wartość dla tego pola lub wartość null, jeśli wartość pola nie została wypełniona przez osoby podpisujące (tj. była to wartość initial_value lub defaul).
value
 value

Wartość pola.

Pobieranie elementu webhook

Identyfikator operacji:
getWebhook

Pobieranie elementu webhook według identyfikatora

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator elementu webhook
 webhookId True uuid

Identyfikator, który jednoznacznie identyfikuje element webhook

Zwraca

Nazwa Ścieżka Typ Opis
enabled
 enabled boolean
event_types
 event_types array of string

typy zdarzeń, które będą uruchamiać element webhook
extra_headers
 extra_headers array of object
id
 extra_headers.id uuid
nazwa
 extra_headers.name string

musi być zgodny z RFC 7230
porządek
 extra_headers.order integer
value
 extra_headers.value string

musi być zgodny z RFC 7230
element webhook
 extra_headers.webhook uuid
id
 id uuid
JSON
 json boolean
URL
 url url

powinien być pełnym adresem URL, w tym http/https

Pobieranie elementu WebhookExtraHeader

Identyfikator operacji:
getWebhookExtraHeader

Pobieranie szczegółów elementu WebhookExtraHeader

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator elementu webhookExtraHeader
 webhookExtraHeaderId True uuid

Identyfikator, który jednoznacznie identyfikuje element WebhookExtraHeader

Zwraca

Nazwa Ścieżka Typ Opis
id
 id uuid
nazwa
 name string

musi być zgodny z RFC 7230
porządek
 order integer
value
 value string

musi być zgodny z RFC 7230
element webhook
 webhook uuid

Pobieranie osoby

Identyfikator operacji:
getPerson

Pobieranie osoby według identyfikatora

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator osoby
 personId True uuid

Identyfikator, który jednoznacznie identyfikuje osobę

Zwraca

Nazwa Ścieżka Typ Opis
Kanały
 channels array of object
e-mail
 channels.email email
id
 channels.id uuid
rodzaj
 channels.kind string

em na adres e-mail. mp dla telefonu.
phone
 channels.phone phone
id
 id uuid
is_user
 is_user boolean

Prawda, jeśli ta osoba jest skojarzona z użytkownikiem BlueInk
metadane
 metadata object

Metadane do skojarzenia z tą osobą. Metadane mogą być używane w funkcji SmartFill do automatycznego wypełniania dokumentów. Aby uzyskać szczegółowe informacje, zobacz dokumentację smartfill.
nazwa
 name string

Imię i nazwisko osoby

Pobieranie pakietu

Identyfikator operacji:
retrieveBundle

Pobieranie pakietu przez slug

Parametry

Nazwa Klucz Wymagane Typ Opis
Pakiet Slug
 bundleSlug True string

Slug, który jednoznacznie identyfikuje pakiet

Pobieranie plików pakietu

Identyfikator operacji:
getBundleFiles

Pobieranie plików do pobrania dla ukończonego pakietu

Parametry

Nazwa Klucz Wymagane Typ Opis
Pakiet Slug
 bundleSlug True string

Slug, który jednoznacznie identyfikuje pakiet

Zwraca

Nazwa Ścieżka Typ Opis
array of object
Wygasa
 expires string

Godzina wygaśnięcia łącza jako czasu sformatowanego iso 8601
file_url
 file_url string

adres URL, z którego można pobrać plik

Pobieranie szablonu dokumentu

Identyfikator operacji:
retrieveTemplate

Pobieranie szablonu dokumentu

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator szablonu
 templateId True uuid

Identyfikator, który jednoznacznie identyfikuje szablon

Zwraca

Nazwa Ścieżka Typ Opis
pola
 fields array of

Tablica pól umieszczonych w dokumencie. Należy pamiętać, że pola DocumentTemplate są nieco inne niż pola DocumentRequest, a default_valueeditor_roles nie initial_value i editors.
file_url
 file_url string

Adres URL oryginalnego pliku, który służy jako podstawa dla tego szablonu
is_shared
 is_shared boolean

Wartość True, jeśli szablon dokumentu jest udostępniony. Fałsz w przeciwnym razie
nazwa
 name string

Nazwa dokumentu. Domyślnie jest to nazwa pliku lub dokument, który został przekazany, ale można go ustawić na przyjazną dla człowieka nazwę.
roles
 roles array of object
klucz
 roles.key string

Ciąg unikatowy dla tego dokumentu, który identyfikuje tę rolę
etykieta
 roles.label string

Przyjazna dla człowieka etykieta dla tej roli

Ponowne generowanie udostępnionego wpisu tajnego elementu webhook

Identyfikator operacji:
regenerateWebhookSecret

Ponowne generowanie udostępnionego wpisu tajnego elementu webhook

Zwraca

Nazwa Ścieżka Typ Opis
create_date
 create_date date-time
klucz tajny
 secret b58

Tworzenie elementu webhook

Identyfikator operacji:
createWebhook

Tworzenie nowego elementu webhook

Parametry

Nazwa Klucz Wymagane Typ Opis
enabled
 enabled boolean
event_types
 event_types array of string

typy zdarzeń, które będą uruchamiać element webhook
id
 id uuid
nazwa
 name string

musi być zgodny z RFC 7230
porządek
 order integer
value
 value string

musi być zgodny z RFC 7230
element webhook
 webhook uuid
id
 id uuid
JSON
 json boolean
URL
 url url

powinien być pełnym adresem URL, w tym http/https

Zwraca

Nazwa Ścieżka Typ Opis
enabled
 enabled boolean
event_types
 event_types array of string

typy zdarzeń, które będą uruchamiać element webhook
extra_headers
 extra_headers array of object
id
 extra_headers.id uuid
nazwa
 extra_headers.name string

musi być zgodny z RFC 7230
porządek
 extra_headers.order integer
value
 extra_headers.value string

musi być zgodny z RFC 7230
element webhook
 extra_headers.webhook uuid
id
 id uuid
JSON
 json boolean
URL
 url url

powinien być pełnym adresem URL, w tym http/https

Tworzenie elementu WebhookExtraHeader

Identyfikator operacji:
createWebhookExtraHeader

Tworzenie nowego nagłówka elementu webhook

Parametry

Nazwa Klucz Wymagane Typ Opis
id
 id uuid
nazwa
 name string

musi być zgodny z RFC 7230
porządek
 order integer
value
 value string

musi być zgodny z RFC 7230
element webhook
 webhook uuid

Zwraca

Nazwa Ścieżka Typ Opis
id
 id uuid
nazwa
 name string

musi być zgodny z RFC 7230
porządek
 order integer
value
 value string

musi być zgodny z RFC 7230
element webhook
 webhook uuid

Tworzenie osadzonego adresu URL podpisywania

Identyfikator operacji:
createPacketEmbedURL

Tworzenie adresu URL, który może służyć do podpisywania osadzonego

Parametry

Nazwa Klucz Wymagane Typ Opis
Pakiet Slug
 packetId True string

Slug, który jednoznacznie identyfikuje pakiet

Zwraca

Nazwa Ścieżka Typ Opis
Wygasa
 expires date-time

Sygnatura czasowa wskazująca, kiedy adres URL wygaśnie
URL
 url string

Adres URL, który może być używany do podpisywania osadzonego

Tworzenie osoby

Identyfikator operacji:
createPerson

Utwórz nową osobę. Osoba może być skojarzona z użytkownikiem BlueInk lub może być osobą autonomiczną. Jeśli chcesz utworzyć osobę skojarzona z użytkownikiem BlueInk, musisz podać user_id pole. Jeśli chcesz utworzyć autonomiczną osobę, musisz podać name pole.

Parametry

Nazwa Klucz Wymagane Typ Opis
e-mail
 email email
id
 id uuid
rodzaj
 kind string

em na adres e-mail. mp dla telefonu.
phone
 phone phone
id
 id uuid
is_user
 is_user boolean

Prawda, jeśli ta osoba jest skojarzona z użytkownikiem BlueInk
metadane
 metadata object

Metadane do skojarzenia z tą osobą. Metadane mogą być używane w funkcji SmartFill do automatycznego wypełniania dokumentów. Aby uzyskać szczegółowe informacje, zobacz dokumentację smartfill.
nazwa
 name string

Imię i nazwisko osoby

Zwraca

Nazwa Ścieżka Typ Opis
Kanały
 channels array of object
e-mail
 channels.email email
id
 channels.id uuid
rodzaj
 channels.kind string

em na adres e-mail. mp dla telefonu.
phone
 channels.phone phone
id
 id uuid
is_user
 is_user boolean

Prawda, jeśli ta osoba jest skojarzona z użytkownikiem BlueInk
metadane
 metadata object

Metadane do skojarzenia z tą osobą. Metadane mogą być używane w funkcji SmartFill do automatycznego wypełniania dokumentów. Aby uzyskać szczegółowe informacje, zobacz dokumentację smartfill.
nazwa
 name string

Imię i nazwisko osoby

Tworzenie pakietu

Identyfikator operacji:
createBundle

Tworzenie i wysyłanie pakietu na potrzeby podpisu

Parametry

Nazwa Klucz Wymagane Typ Opis
body
 body

Treść JSON, która definiuje pakiet do utworzenia

Usuwanie elementu webhook

Identyfikator operacji:
deleteWebhook

Usuwanie elementu webhook według identyfikatora

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator elementu webhook
 webhookId True uuid

Identyfikator, który jednoznacznie identyfikuje element webhook

Usuwanie elementu WebhookExtraHeader

Identyfikator operacji:
deleteWebhookExtraHeader

Usuwanie elementu WebhookExtraHeader

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator elementu webhookExtraHeader
 webhookExtraHeaderId True uuid

Identyfikator, który jednoznacznie identyfikuje element WebhookExtraHeader

Usuwanie osoby

Identyfikator operacji:
deletePerson

Usuń osobę. Spowoduje to również usunięcie wszystkich skojarzonych użytkowników rozwiązania BlueInk.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator osoby
 personId True uuid

Identyfikator, który jednoznacznie identyfikuje osobę

Usuwanie tagów z pakietu

Identyfikator operacji:
removeBundleTags

Usuwanie tagów z pakietu. Jeśli tag w żądaniu nie istnieje w pakiecie, zostanie zignorowany.

Parametry

Nazwa Klucz Wymagane Typ Opis
Pakiet Slug
 bundleSlug True string

Slug, który jednoznacznie identyfikuje pakiet
tags
 tags array of string

Tablica tagów

Uzyskiwanie udostępnionego wpisu tajnego elementu webhook

Identyfikator operacji:
getWebhookSecret

Uzyskiwanie udostępnionego wpisu tajnego elementu webhook

Zwraca

Nazwa Ścieżka Typ Opis
create_date
 create_date date-time
klucz tajny
 secret b58

Wysyłanie przypomnienia

Identyfikator operacji:
sendPacketReminder

Wyślij wiadomość e-mail z przypomnieniem lub wiadomość SMS do sygnatariusza. Przypomnienie można wysyłać tylko raz na godzinę. Przypomnienie zostanie wysłane za pośrednictwem metody dostarczania (wiadomości e-mail lub wiadomości SMS) oraz do adresu e-mail (lub numeru telefonu) wyznaczonego wcześniej dla tego pakietu.

Parametry

Nazwa Klucz Wymagane Typ Opis
Pakiet Slug
 packetId True string

Slug, który jednoznacznie identyfikuje pakiet

Wyświetlanie listy elementów webhook

Identyfikator operacji:
listWebhooks

Wyświetlanie listy wszystkich elementów webhook na koncie BlueInk

Parametry

Nazwa Klucz Wymagane Typ Opis
Włączona
 enabled boolean

Zostaną zwrócone tylko elementy webhook pasujące do wybranego stanu "włączone".

Np. /webhooks/?enabled=true
Typ zdarzenia
 event_type string

Zostaną zwrócone tylko elementy webhook pasujące do wybranego event_type lub event_types.

Np. /webhooks/?event_type=bundle_sent/webhooks/?event_type__in=bundle_error,bundle_cancelled

Zwraca

Nazwa Ścieżka Typ Opis
array of object
enabled
 enabled boolean
event_types
 event_types array of string

typy zdarzeń, które będą uruchamiać element webhook
extra_headers
 extra_headers array of object
id
 extra_headers.id uuid
nazwa
 extra_headers.name string

musi być zgodny z RFC 7230
porządek
 extra_headers.order integer
value
 extra_headers.value string

musi być zgodny z RFC 7230
element webhook
 extra_headers.webhook uuid
id
 id uuid
JSON
 json boolean
URL
 url url

powinien być pełnym adresem URL, w tym http/https

Wyświetlanie listy elementów webhookEvent

Identyfikator operacji:
listWebhookEvents

Wyświetlanie listy wszystkich zdarzeń elementu webhook na koncie BlueInk

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator elementu webhook
 webhook uuid

Zostaną zwrócone tylko elementy webhookEvent pasujące do wybranego identyfikatora elementu webhook.

Np. /webhooks/events/?webhook=a053644f-e371-4883-ac17-534445993346
Typ zdarzenia
 event_type string

Zostaną zwrócone tylko elementy webhookEvent z elementami webhook pasującymi do wybranego event_type lub event_types.

Np. /webhooks/events/?event_type=bundle_sent/webhooks/events/?event_type__in=bundle_error,bundle_cancelled
Status
 status integer

Zostaną zwrócone tylko elementy webhookEvent pasujące do wybranego stanu.

Np. /webhooks/events/?status=1/webhooks/events/?status__in=0,1,2
Wynik powodzenia
 success boolean

Zostaną zwrócone tylko elementy WebhookEvent pasujące do wybranego stanu powodzenia.

Np. /webhooks/events/?success=true
Zakres dat
 date date-time

Zostaną zwrócone tylko elementy WebhookEvent występujące między zakresem dat. Uwaga: daty są wyrażane jako format RRRR-MM-DD.

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

Zwraca

Nazwa Ścieżka Typ Opis
array of object
utworzone
 created date-time
Dostawy
 deliveries array of object
komunikat
 deliveries.message string

komunikat opisujący wszelkie problemy
Pk
 deliveries.pk uuid
stan
 deliveries.status integer

komunikat o stanie odpowiedzi lub 0, jeśli nie ma stanu
sygnatura czasowa
 deliveries.timestamp date-time

gdy nastąpiła próba dostarczenia (początek próby, a nie w przypadku niepowodzenia, np. przekroczenie limitu czasu)
event_type
 event_type string
ładunek
 payload string

ładunku do wysłania przy dostawie; JSON
Pk
 pk uuid
stan
 status integer

kod stanu ostatniej odpowiedzi z punktu końcowego elementu webhook. 0 wskazuje, że nie odebrano odpowiedzi
sukces
 success boolean
element webhook
 webhook uuid

UUID identyfikujący element webhook, do którego należy zdarzenie

Wyświetlanie listy elementów webhookEvent

Identyfikator operacji:
listWebhookDeliveries

Wyświetlanie listy wszystkich elementów webhookDeliveries na koncie BlueInk

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator elementu webhook
 webhook uuid

Zostaną zwrócone tylko elementy webhookDeliveries pasujące do wybranego identyfikatora elementu webhook.

Np. /webhooks/deliveries/?webhook=a053644f-e371-4883-ac17-534445993346
Identyfikator zdarzenia elementu webhook
 webhook_event uuid

Zostaną zwrócone tylko elementy webhookDeliveries pasujące do wybranego identyfikatora webhook_event.

Np. /webhooks/deliveries/?webhook_event=a053644f-e371-4883-ac17-534445993346
Typ zdarzenia
 event_type string

Zostaną zwrócone tylko elementy webhookDeliveries z elementami webhook pasującymi do wybranej event_type lub event_types.

Np. /webhooks/deliveries/?event_type=bundle_sent/webhooks/deliveries/?event_type__in=bundle_error,bundle_cancelled
Status
 status integer

Zostaną zwrócone tylko elementy webhookDeliveries pasujące do wybranego stanu.

Np. /webhooks/deliveries/?status=1/webhooks/deliveries/?status__in=0,1,2
Zakres dat
 date date-time

Zostaną zwrócone tylko elementy webhookDeliveries występujące między zakresem dat. Uwaga: daty są wyrażane jako format RRRR-MM-DD.

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

Zwraca

Nazwa Ścieżka Typ Opis
array of object
utworzone
 created date-time
Dostawy
 deliveries array of object
komunikat
 deliveries.message string

komunikat opisujący wszelkie problemy
Pk
 deliveries.pk uuid
stan
 deliveries.status integer

komunikat o stanie odpowiedzi lub 0, jeśli nie ma stanu
sygnatura czasowa
 deliveries.timestamp date-time

gdy nastąpiła próba dostarczenia (początek próby, a nie w przypadku niepowodzenia, np. przekroczenie limitu czasu)
event_type
 event_type string
ładunek
 payload string

ładunku do wysłania przy dostawie; JSON
Pk
 pk uuid
stan
 status integer

kod stanu ostatniej odpowiedzi z punktu końcowego elementu webhook. 0 wskazuje, że nie odebrano odpowiedzi
sukces
 success boolean
element webhook
 webhook uuid

UUID identyfikujący element webhook, do którego należy zdarzenie

Wyświetlanie listy elementów webhookExtraHeaders

Identyfikator operacji:
listWebhookExtraHeaders

Wyświetlanie listy wszystkich elementów WebhookExtraHeaders na koncie BlueInk

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator elementu webhook
 webhook uuid

Zostaną zwrócone tylko elementy WebhookExtraHeaders pasujące do wybranego identyfikatora elementu webhook.

Np. /webhooks/headers/?webhook=a053644f-e371-4883-ac17-534445993346
Typ zdarzenia
 event_type string

Zostaną zwrócone tylko elementy webhookExtraHeaders z elementami webhook pasującymi do wybranej event_type lub event_types.

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

Zwraca

Nazwa Ścieżka Typ Opis
array of object
id
 id uuid
nazwa
 name string

musi być zgodny z RFC 7230
porządek
 order integer
value
 value string

musi być zgodny z RFC 7230
element webhook
 webhook uuid

Wyświetlanie listy szablonów dokumentów

Identyfikator operacji:
listTemplates

Wyświetlanie listy wszystkich szablonów dokumentów

Zwraca

Nazwa Ścieżka Typ Opis
pola
 fields array of

Tablica pól umieszczonych w dokumencie. Należy pamiętać, że pola DocumentTemplate są nieco inne niż pola DocumentRequest, a default_valueeditor_roles nie initial_value i editors.
file_url
 file_url string

Adres URL oryginalnego pliku, który służy jako podstawa dla tego szablonu
is_shared
 is_shared boolean

Wartość True, jeśli szablon dokumentu jest udostępniony. Fałsz w przeciwnym razie
nazwa
 name string

Nazwa dokumentu. Domyślnie jest to nazwa pliku lub dokument, który został przekazany, ale można go ustawić na przyjazną dla człowieka nazwę.
roles
 roles array of object
klucz
 roles.key string

Ciąg unikatowy dla tego dokumentu, który identyfikuje tę rolę
etykieta
 roles.label string

Przyjazna dla człowieka etykieta dla tej roli

Wyświetlanie listy zdarzeń pakietu

Identyfikator operacji:
listBundleEvents

Pobieranie listy zdarzeń skojarzonych z pakietem

Parametry

Nazwa Klucz Wymagane Typ Opis
Pakiet Slug
 bundleSlug True string

Slug, który jednoznacznie identyfikuje pakiet

Zwraca

Nazwa Ścieżka Typ Opis
array of object
opis
 description string

Krótka kroplówka wydarzenia
rodzaj
 kind string

Rodzaj zdarzenia jako kod 2 znaków
packet_id
 packet_id uuid

Identyfikator UUID pakietu. Występuje tylko wtedy, gdy zdarzenie jest skojarzone z określonym pakietem.
sygnatura czasowa
 timestamp date-time

Godzina wystąpienia zdarzenia