95 lines
3.6 KiB
Markdown
95 lines
3.6 KiB
Markdown
# hightrusted CAPTURE — Postman Collection
|
|
|
|
> **Status:** v0.1 Preview — API stabil, Collection wird mit jedem API-Release aktualisiert
|
|
|
|
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. Kein US-Cloud-Anbieter
|
|
in der Verarbeitungskette.
|
|
|
|
## Inhalt
|
|
|
|
- `hightrusted-capture.postman_collection.json` — alle Endpoints mit Beispielen
|
|
- `hightrusted-capture.postman_environment.json` — Environment-Template (`api_key`, `base_url`)
|
|
|
|
## Endpoints in der Collection
|
|
|
|
- `POST /captures` — Capture erstellen (sync / async / webhook)
|
|
- `GET /captures/{id}` — Status abfragen
|
|
- `GET /captures/{id}/pdf` — PDF herunterladen
|
|
- `GET /captures/{id}/verify` — Capture verifizieren (kostenlos, ohne API-Key)
|
|
- `GET /usage` — eigenen Verbrauch abrufen
|
|
|
|
## Nutzung
|
|
|
|
### Variante 1 — Direkt-Import in Postman
|
|
|
|
1. Postman öffnen → **Import** → diese beiden Files auswählen
|
|
2. Im Environment `hightrusted-capture` den Wert `api_key` setzen
|
|
(Dashboard: https://capture.hightrusted.net/dashboard/api-keys)
|
|
3. Environment auswählen → Requests senden
|
|
|
|
### Variante 2 — Öffentlicher Workspace
|
|
|
|
Direkter Fork aus dem öffentlichen Postman-Workspace:
|
|
https://www.postman.com/hightrusted/workspace/capture-api
|
|
|
|
## Authentifizierung
|
|
|
|
Bearer-Token. In der Collection bereits voreingestellt — du musst nur die
|
|
Variable `{{api_key}}` im Environment befüllen.
|
|
|
|
## Tests in der Collection
|
|
|
|
Jede Request hat einfache Response-Tests:
|
|
|
|
- HTTP-Status korrekt
|
|
- `request_id`-Header gesetzt
|
|
- Bei `POST /captures` (sync): `id`, `status`, `verify_url` vorhanden
|
|
- Bei `GET /captures/{id}/verify`: `valid` ist Boolean
|
|
|
|
Damit kannst du die Collection auch im Newman-CI nutzen:
|
|
|
|
```bash
|
|
newman run hightrusted-capture.postman_collection.json \
|
|
-e hightrusted-capture.postman_environment.json
|
|
```
|
|
|
|
## Versionierung
|
|
|
|
Diese Collection folgt der API-Version (`/api/v1/...`). Breaking Changes der API
|
|
führen zu einer neuen Major-Version der Collection. Non-Breaking Changes
|
|
(neue Endpoints, neue Felder) werden ohne Versionssprung eingepflegt.
|
|
|
|
## Verwandte Repositorys
|
|
|
|
**Im selben Produkt** ([`hightrusted-capture`](https://git.hightrusted.net/hightrusted-capture)):
|
|
|
|
- [`openapi`](https://git.hightrusted.net/hightrusted-capture/openapi) — OpenAPI 3.1 Spec (Single Source of Truth)
|
|
- [`examples`](https://git.hightrusted.net/hightrusted-capture/examples) — Beispiel-Anwendungen
|
|
- [`python`](https://git.hightrusted.net/hightrusted-capture/python) — Python-SDK
|
|
- [`node`](https://git.hightrusted.net/hightrusted-capture/node) — Node.js-SDK
|
|
- [`php`](https://git.hightrusted.net/hightrusted-capture/php) — PHP-SDK
|
|
|
|
**Plattform-übergreifend** ([`hightrusted`](https://git.hightrusted.net/hightrusted)):
|
|
|
|
- [`platform`](https://git.hightrusted.net/hightrusted/platform) — Plattform-Übersicht, Architektur, Produkt-Liste
|
|
- [`developer-portal`](https://git.hightrusted.net/hightrusted/developer-portal) — gemeinsame Konventionen, Auth, Errors, Rate-Limits
|
|
- [`compliance`](https://git.hightrusted.net/hightrusted/compliance) — DSGVO, AGB-Templates, Whitepaper
|
|
|
|
## Support
|
|
|
|
- **Doku:** https://capture.hightrusted.net/api/docs
|
|
- **Status-Page:** https://status.hightrusted.net
|
|
- **Developer Support:** developers@hightrusted.net
|
|
- **Sicherheitslücken:** siehe [SECURITY.md](./SECURITY.md)
|
|
|
|
## Lizenz
|
|
|
|
MIT — siehe [LICENSE](./LICENSE).
|
|
|
|
---
|
|
|
|
**hightrusted GmbH** — *The European Trust Infrastructure.*
|
|
Made in Germany. DSGVO-nativ. eIDAS-konform.
|