Stefan Schmidt-Egermann
ad6687ce5d
- Postman Collection v2.1 mit allen Endpoints - Environment-Template für api_key + base_url - Tests pro Request (Status, Schema-Checks)
83 lines
2.6 KiB
Markdown
83 lines
2.6 KiB
Markdown
# hightrusted CAPTURE — Postman Collection
|
|
|
|
> **Status:** v1.0.0 — synchron mit OpenAPI Spec
|
|
|
|
Postman-Collection für die [hightrusted CAPTURE API](https://capture.hightrusted.net) —
|
|
forensische Web-Captures mit qualifiziertem Zeitstempel nach RFC 3161 / eIDAS Art. 41.
|
|
|
|
**Made in Germany.** Server in Deutschland. DSGVO-nativ.
|
|
|
|
## Inhalt
|
|
|
|
- `hightrusted-capture.postman_collection.json` — alle Endpoints mit Tests
|
|
- `hightrusted-capture.postman_environment.json` — Environment mit `api_key`, `base_url`
|
|
|
|
## Endpoints in der Collection
|
|
|
|
**Captures:**
|
|
- Capture erstellen — synchron / asynchron / webhook
|
|
- Capture-Status abrufen
|
|
- Captures auflisten
|
|
- PDF herunterladen
|
|
|
|
**Verify:**
|
|
- Verifikation per Capture-ID
|
|
- Verifikation per Verify-URL
|
|
- Verifikation per PDF-Upload
|
|
|
|
**Account:**
|
|
- Eigenen Verbrauch abrufen
|
|
|
|
## Nutzung
|
|
|
|
### Variante 1 — Direkt-Import
|
|
|
|
1. Postman → **Import** → beide JSON-Dateien auswählen
|
|
2. Im Environment `hightrusted CAPTURE — Production` den Wert `api_key` setzen
|
|
(Dashboard: https://capture.hightrusted.net/dashboard/api-keys)
|
|
3. Environment auswählen → Requests senden
|
|
|
|
### Variante 2 — Newman CI
|
|
|
|
```bash
|
|
npm install -g newman
|
|
newman run hightrusted-capture.postman_collection.json \
|
|
-e hightrusted-capture.postman_environment.json \
|
|
--env-var "api_key=$HIGHTRUSTED_API_KEY"
|
|
```
|
|
|
|
## Tests in der Collection
|
|
|
|
Jede Request hat Response-Tests:
|
|
- HTTP-Status korrekt
|
|
- Schema-Felder vorhanden (`id`, `status`, `verify_url`, etc.)
|
|
- Beim Capture-Erstellen wird die `id` als Collection-Variable `last_capture_id`
|
|
gesetzt — die nachfolgenden Requests (Status, PDF, Verify) nutzen sie automatisch.
|
|
|
|
So kannst du mit drei Klicks einen kompletten Lifecycle durchlaufen:
|
|
**Capture erstellen → Status prüfen → PDF herunterladen → Verifizieren**.
|
|
|
|
## Versionierung
|
|
|
|
Diese Collection folgt der API-Version (`/api/v1/...`). Sie wird mit jedem
|
|
API-Release aktualisiert. Breaking Changes der API führen zu einer neuen
|
|
Major-Version der Collection.
|
|
|
|
## Verwandte Repositorys
|
|
|
|
- [`openapi`](https://git.hightrusted.net/hightrusted-capture/openapi) — OpenAPI 3.1 Spec
|
|
- [`examples`](https://git.hightrusted.net/hightrusted-capture/examples) — Beispiel-Anwendungen
|
|
- [`python`](https://git.hightrusted.net/hightrusted-capture/python) / [`node`](https://git.hightrusted.net/hightrusted-capture/node) / [`php`](https://git.hightrusted.net/hightrusted-capture/php) — SDKs
|
|
|
|
## Support
|
|
|
|
- **Doku:** https://capture.hightrusted.net/api/docs
|
|
- **Developer Support:** developers@hightrusted.net
|
|
|
|
## Lizenz
|
|
|
|
MIT — siehe [LICENSE](./LICENSE).
|
|
|
|
---
|
|
|
|
**hightrusted GmbH** — *The European Trust Infrastructure.*
|