Zewnętrzne API obszaru roboczego
dostępne w obszarze roboczymPrzesyłanie dokumentów, odczyt statusu, lista formatów eksportu, zlecanie eksportów i integracja procesów miesięcznych.
Integracja API
Łącz kontrolowane dane faktur z ERP, DMS, księgowością i indywidualnymi procesami finansowymi.
Wymagane logowanie do obszaru roboczegoDostępy i sposoby integracji
Przesyłanie dokumentów, odczyt statusu, lista formatów eksportu, zlecanie eksportów i integracja procesów miesięcznych.
Publiczny proces przesyłania, ekstrakcji, kontroli, walidacji, tworzenia artefaktów i chronionego pobierania danych strukturyzowanych.
Linki weryfikacyjne i kody QR tworzone w Convert pokazują ograniczone metadane. Pobieranie danych strukturyzowanych pozostaje chronione.
Przekazywanie zdarzeń dokumentów, faktur, eksportów i procesów miesięcznych do własnych systemów.
Zarządzanie zakresami, limitami, użyciem i kluczami środowiska testowego oraz produkcyjnego.
Status implementacji
POST /api/v1/documents Prześlij dokument do procesu w obszarze roboczym dostępne w obszarze roboczymGET /api/v1/documents/{document_id} Odczytaj status i metadane dokumentu dostępne w obszarze roboczymGET /api/v1/invoices/{invoice_id} Odczytaj status faktury i kontroli dostępne w obszarze roboczymGET /api/v1/export-formats Pobierz listę zatwierdzonych formatów eksportu dostępne w obszarze roboczymPOST /api/v1/invoices/{invoice_id}/exports Przekaż żądanie eksportu do wewnętrznego procesu dostępne w obszarze roboczymPOST /api/convert/jobs Utwórz publiczny proces Convert dostępny proces publicznyPOST /api/convert/jobs/{job_id}/validate Sprawdź dane walidatorem wybranego formatu docelowego dostępny proces publicznyPOST /api/convert/jobs/{job_id}/generate Utwórz artefakt; pobieranie pozostaje chronione do czasu odblokowania dostępny proces publicznyPOST /api/v1/convert/extract Wersjonowany dostęp External API dla Convert na zapytanie / planowanePOST /api/v1/verify-links Wersjonowany dostęp External API dla Verify/QR na zapytanie / planowaneDostęp i odpowiedzialność
Klucze API są tworzone w obszarze roboczym i pokazywane w całości tylko raz. Zakresy, limity, użycie, webhooki oraz rozdział środowiska testowego i produkcyjnego są sprawdzane po stronie serwera. Żądania zapisujące powinny używać nagłówka Idempotency-Key.
Uwierzytelnione API obszaru roboczego obejmuje dokumenty, status faktur, formaty eksportu, pakiety eksportowe i procesy miesięczne. Publiczny proces Convert korzysta z oddzielnych endpointów /api/convert. Wersjonowane endpointy /api/v1 dla Convert i Verify są oznaczane jako dostępne dopiero po implementacji i wydaniu.