Centrum pomocyIntegracje

Dla: Administratorzy

Wysyłaj podpisy elektroniczne i czytaj podpisy za pomocą klucza centralnego

Utwórz podpis elektroniczny w sprawie z szablonu, wybierz, kto podpisze każde pole, opublikuj sprawę do podpisu i pobierz zablokowaną kopię, gdy wszyscy podpiszą.

W tym artykule9 sekcji

Zanim zaczniesz

Ta strona opisuje proces wysyłania danych elektronicznychPodpis elektroniczny Dokument wysłany do podpisu elektronicznego, podpisany w przeglądarce. oraz następujące po nich kody kluczowe. Drogi dostarczania danych znajdują się pod https://prd-api-app.caseactive.com/v1/<hub id>/<case id>.

Połączenia

DzwonićCo to robi
GET /signs/templatesLista twoich szablon e-signów
POST /signsStworzy elektroniczną wersję dokumentu, która nie została jeszcze opublikowana.
PUT /signs/<sign_id>/schemaWybiera się osobę, która będzie podpisywać każde pole.
PUT /signs/<sign_id>Zmienia nazwę, datę realizacji lub informacje dotyczące terminów realizacji przed publikacją.
PUT /signs/<sign_id>/publishPublikuje to, co zostało przesłane do odbiorców.
GET /signs?filter=allWylicza elektroniczne dokumenty z danego przypadku.
GET /signs/<sign_id>Czyta jeden e-sign, wraz z jego statusem.
DELETE /signs/<sign_id>Usuń to, wraz z wszystkimi znakami rozpoznawczymi.
GET /signs/<sign_id>/responsesLista jego signaturech
GET /signs/<sign_id>/responses/<response_id>Czytanie jednego podpisu

E-signy są publikowane krok po kroku: najpierw tworzy się je, następnie sprawdza się, kto podpisuje każdy pol lub tekst, a potem signy tego e-signu są publikowane. Dopóki e-sign nie zostanie publikowany, jego autorytatyści nie mogą go zobaczyć, a nikt o tym nie wie. Gdy e-sign zostanie publikowany, nic o nim nie może się zmienić.

Tworzenie podpisu elektronicznego

GET /signs/templates Lista twoich publikowanych elektronicznych dokumentów. szablonySzablon Wielokrotnego użytku wpis, formularz, podpis elektroniczny, notatka lub zadanie przechowywane w bibliotece i kopiowane do spraw., Najstarszy najpierw, z każdym z nich… asset_id, title, description, due_mins Ile minut minie od momentu wysłania danych? notifications, i role_field_participants, Rolki, które oznaczają poszczególne pola.

POST /signs przyjmuje:

PoleCo to robiWymaganyDomyślny
nameTytuł e-szczytu. Litery, cyfry, spacje i & ' - _ ( ) . /; brak kropków ani kółek.Tak.–
duration{"due_date": "2026-10-09T17:00:00-04:00"}, wraz z odstępem czasu w strefie czasowej. Znaków elektronicznych nie można powtarzać – zasada ta jest niedopuszczalna.Tak.–
template{"owner": "host", "template_id": "<asset_id>"} Aby wykorzystać dokument i podpisy dostępne w szablonie.NieŻadnego.
descriptionNota przedstawiona w formie e-signuNieŠablona jest…
notificationsPamiątki: {"names": ["days"], "values": [-1440]}, każda wartość w minutach przed terminem płatnościNieŠablona… lub nic.
instant_notifyfalse W czasie publikacji nie należy wysyłać żadnych żądań, tylko upomnienia.NieŠablona, czyli true
curl -X POST https://prd-api-app.caseactive.com/v1/ca-7e6d5c4b3a2f10/cc-1a2b3c4d5e6f70/signs \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name": "Retainer Agreement", "duration": {"due_date": "2026-10-09T17:00:00-04:00"}, "template": {"owner": "host", "template_id": "sign::20260915101500_7a6b5c4d3e2f10"}}'

Odpowiada na 201 za pomocą sign_id. Dokument z tematu jest kopiowany w tle: należy przeczytać e-signa, aż nie będzie już żadnych copying.

Aby wysłać swój własny plik PDF, należy utworzyć e-sign bez elementu template. Następnie załadować plik PDF jako dokument i czekać, aż będzie gotowy. Potem należy przydzielić odpowiednie pola do tego pliku. Szczegóły znajdują się w opisie Władowanie i przykładanie plików za pomocą klucza hub.

Wybór osoby podpisującej

Z szablonu każdy pol jest przekazywany osobom zajmującym odpowiednie role w przypadku tworzenia elektronicznego dokumentu. Dlatego należy najpierw umieścić klienta w tym przypadku. field_participants w elektronicznym dokumencie pokazuje nazwy poszczególnych polów, wraz z identyfikatorami użytkowników, którzy dokonywają podpisywania tego dokumentu.

Aby to zmienić, wyślij całą mapę do PUT /signs/<sign_id>/schema:

{"field_participants": {"Client Signature": ["cu-4f1c2a9e8b7d60"], "Attorney Signature": ["cu-9d8c7b6a5f4e30"]}}
  • Każdy identyfikator musi należeć do osoby, która ma kontrolę nad tą sprawą. Asystent wirtualny nie może podpisywać dokumentów.
  • Nazwy poli to te nazwy, które znajdują się w dokumencie.
  • Mapa zastępuje tę starszą mapę: pola, które zostały pominięte na tej nowej mapie, nie mają żadnych oznaczeń.

Wydawniczy

PUT /signs/<sign_id>/publish nie przyjmuje żadnego obiektu i odpowiada na 200. Przynajmniej jedno polo musi mieć „signer”; polo bez takiego elementu pozostaje puste.

  • Każdy podpisujący otrzymuje e-mail z prośbą o podpisanie dokumentu. Jeśli nie ma aktywnego adresu e-mail, otrzymuje też wiadomość tekstowa. To odbywa się natychmiast, chyba że… instant_notify to false. Wygląda na to, że znajduje się na nich. ZrobićDo zrobienia Lista rzeczy czekających na Ciebie, np. formularzy do wypełnienia, dokumentów do podpisania lub zdarzeń do potwierdzenia. A także w powiadomieniach przesyłanych na ich portalu.
  • Pamiątki są wysyłane za każdym razem w okresie notifications, aż do momentu podpisania się uczestników.
  • Ktoś, który jest z daleka od tego miejsca, przestaje trzymać ten przedmiot w rękach.

Podążając za podpisami

E-sign status czytam completed Gdy wszyscy podpiszą dokument, i… completed_on Powiada, kiedy, w UTC, na przykład… 2026-10-06T21:42:10.123456+00:00. Do tego czasu nie ma żadnego z nich. responses Każdy podpisany stronnik ma swoje mapy. response_id.

GET /signs/<sign_id>/responses Wykaz zawiera listę podpisów każdego podpisacza, w kolejności według wieku, wszystko na jednej stronie. Każdy podpisacze ma swój własny podpis. user_id, Gdy podpisali umowę, wypełnili pola zawierające informacje o tym, co chcieli zrobić. response.formFieldValues, podpisują swoje podpisy response.annotations, Z dowolnym obrazem podpisanym. response.attachments, I adres IP, który podpisały. response.ip.

Personel zajmujący się tą sprawą jest informowany za każdym razem, gdy ktoś podpisuje dokumenty. Ponownie informuje się go o tym, gdy gotowy jest podpisany egzemplarz dokumentu – tak samo, jakby to zrobił on sam. Każdemu osobie, która podpisała dokumenty, również informuje się o tym momentie.

Zablokowana kopia

Po złożeniu wszystkich podpisów, tworzy się zamkniętą kopię dokumentu, do której dołączone są wszystkie podpisy. Element wpisany pod media.schemas.items otrzymuje wartość flat, a także ścieżkę do tej kopii oraz wartości flat_status, SUCCEEDED lub FAILED. Można jej pobrać w dowolnej formie; informacje na temat tego procesu znajdziesz w sekcji Przechowywanie i łączenie plików za pomocą klucza hub.

Wypisywanie i usuwanie

GET /signs wymaga filter: all wyświetla wszystkie e-signy znajdujące się w tej kopii, w tym te niepublikowane. Najnowsze e-signy są umieszczone na początku listy. self wyświetla te e-signy przesłane przez Wirtualnego Asystenta, za pomocą dowolnych kluczy lub automatów. completed i uncompleted wyświetlają e-signy należące do samego rozmówcy. Dlatego też te pola zawsze są puste w przypadku klucza. Zamiast tego sprawdź pola status i completed_on przy każdym e-signie.

DELETE /signs/<sign_id> może kiedykolwiek usunąć dane z elektronicznego dokumentu, wraz z wszystkimi podpisami na nim. Dokument ten zostaje więc usunięty z listy zadań do wykonania przez wszystkich użytkowników. Nikt o tym nie wie.

Jeśli połączenie zostanie odrzucone

StatusmessageDlaczego
400SchemaFieldsExceptionW tekście brakuje lub jest to nieprawidłowe pole, np. kropka w name, reguła powtórzenia, albo osoba, która nie należy do tej grupy; errors podaje nazwę tego pola.
400SchemaFieldsException, przy czym ItemCopyNotAllowedException znajduje się w obrębie templateŠablona nie została opublikowana, nie jest dostępna dla botów, lub jej pliki nadal są przetwarzane.
403PublishAlreadyPublishedExceptionJuż zostało to opublikowane, więc nie może się nic zmienić.
403PublishAlreadyAnsweredExceptionKtoś już podpisał ten dokument.
403PublishParticipantsMissingExceptionŻaden pol nie ma żadnego znaku potwierdzającego jego istnienie.
403PublishMediaMissingExceptionJeszcze nie ma żadnych dokumentów związanych z tym tematem.
403PublishMediaNotReadyExceptionJego dokument jest nadal kopiowany lub konwertowany na inny format.
403PublishMediaFailedExceptionJego dokument nie zdołał zostać przetworzony.
403PublishDocumentUnreadableExceptionJego dokument nie może być odczytany: należy usunąć e-szczyt i stworzyć go ponownie.
403PublishDueTimePassedExceptionData wydania minęła
403BotNotAllowedExceptionKlucz chciał podpisać ten dokument, albo usunąć podpis kogokolwiek.
403CaseClosedExceptionSprawa została zamknięta.
404ItemNotFoundExceptionE-szczyt lub podpis nie istnieją.

Informacje dotyczące kodu błędów oraz pozostałych kodów znajdują się w sekcji Obsługa błędów API i kodów statusowych.

Powiązane artykuły

Zrozum, co może zrobić APIDowiedz się, do czego służy klucz zarządzający i klucz centralny, dlaczego każdy klucz pełni funkcję wirtualnego asystenta i gdzie znajduje się pełna lista danych technicznych.IntegracjeWysyłaj formularze i czytaj odpowiedzi za pomocą klucza centralnegoUtwórz formularz dotyczący danej sprawy na podstawie szablonu, opublikuj go osobom, które powinny go wypełnić, i przeczytaj ich odpowiedzi.IntegracjePrzesyłaj i dołączaj pliki za pomocą klucza HubUzyskaj adres do przesyłania, prześlij plik, załącz go do wpisu, notatki, zadania, formularza lub podpisu elektronicznego i pobierz pliki sprawy.IntegracjeObsługa błędów API i kodów statusuPrzeczytaj treść błędu, co oznaczają kody 400, 401, 403, 404, 500 i 503 i dlaczego element, którego klucz dotyczy, nie widzi odpowiedzi 404.Integracje