Toutes les routes
/api/compliance/* s’authentifient avec votre token de session /
accès de console (le même login que vous utilisez pour le dashboard), pas une clé
de relais sk-orca-…. Configurez tout depuis la console ; la surface REST ci-dessous
sert à automatiser la collecte de preuves en CI.1. Ce que couvre la référence de l’API compliance
Deux groupes de routes, deux publics :| Groupe | Auth | Public |
|---|---|---|
/api/compliance/* | Session de console | Vous + vos auditeurs (dans l’espace de travail) |
/api/public/compliance/* | Aucune (token / signature) | Quiconque vérifie un rapport |
2. Parcourir le catalogue et vérifier la préparation
Commencez en lecture seule. Ces trois endpoints ne nécessitent aucun rôle spécial et ne coûtent rien :GET /api/compliance/catalog — chaque référentiel que vous pouvez cibler
GET /api/compliance/catalog — chaque référentiel que vous pouvez cibler
Renvoie le registre des référentiels. OrcaRouter livre des packs pour les grands
régimes de sécurité, de vie privée et de gouvernance IA — y compris
soc2,
hipaa, gdpr, uk_gdpr, eu_ai_act, iso_27001, iso_42001,
nist_ai_rmf, nist_800_53, pci_dss, glba, ccpa, et une longue traîne de
lois régionales sur la vie privée (PIPL, APPI, PIPA, LGPD, PIPEDA, DPDP, et les
lois des États américains). OWASP Top 10 for LLM Applications
(owasp_llm) est livré comme un pack first-class également — il matérialise des
contrôles guardrail et firewall réels (injection de prompt, sortie non sûre,
divulgation sensible, agence excessive) tout comme chaque autre référentiel.GET /api/compliance/packs — ce que vous avez installé
GET /api/compliance/packs — ce que vous avez installé
Liste les packs déjà matérialisés dans cet espace de travail, chacun avec son mode
de cycle de vie (
observe ou enforce) et la politique guardrail + firewall qu’il
a créée.GET /api/compliance/readiness — votre rapport de lacunes
GET /api/compliance/readiness — votre rapport de lacunes
Score votre posture actuelle contre la checklist de chaque référentiel : quels
contrôles vos guardrails et règles firewall en direct satisfont déjà, et lesquels
restent des lacunes organisationnelles que vous devez combler vous-même. Lisez ceci
avant d’installer quoi que ce soit.
3. Installer un pack
Installer un pack est le moment de valeur : il écrit un vraiGuardrail (plan texte/données) et une WorkspaceFirewallPolicy plus des règles
(plan appel d’outil) dans votre espace de travail, tagués au référentiel. Les deux sont
entièrement éditables ensuite — le pack est un point de départ, pas un template
verrouillé.
flag, firewall en shadow/log-only — afin que vous puissiez observer la couverture
avant que quoi que ce soit ne bloque le trafic en direct. Quand vous êtes prêt,
promouvez-le :
POST …/packs/:key/controls pour câbler un
seul contrôle, POST …/packs/:key/update pour re-synchroniser après un changement du
catalogue, et DELETE …/packs/:key pour désinstaller.
4. Générer un rapport de preuve signé
Le rapport est l’artefact que vous remettez à un auditeur. Chacun est rendu à partir de votre posture en direct, haché par contenu avec SHA-256, et signé avec Ed25519 afin qu’il ne puisse pas être édité silencieusement après coup.pdf, json, et csv.
Listez et récupérez les rapports avec GET …/reports et GET …/reports/:id ;
téléchargez le fichier rendu avec GET …/reports/:id/download (Admin).
5. Laisser un auditeur le vérifier — sans compte requis
Trois endpoints publics rendent un rapport vérifiable indépendamment par quiconque détient le fichier :Obtenir la clé publique
GET /api/public/compliance/pubkey renvoie la clé publique Ed25519 avec laquelle
vos rapports sont signés.Vérifier une signature
POST /api/public/compliance/verify vérifie la signature et le hash de contenu
d’un rapport et indique à l’appelant s’il a été altéré.Partager avec un auditeur
Frappez un lien en lecture seule depuis
POST …/reports/:id/share (Admin) ;
l’auditeur ouvre GET /api/public/compliance/share/:token — sans login.6. Résidence des données
La résidence ici est la région sous laquelle votre preuve de conformité est estampée et stockée —us, eu, uk, ap, cn, ou global. Elle gouverne où les rapports
vivent et depuis quelle région ils peuvent être servis ; un rapport est retenu s’il est
lu depuis une région non correspondante. (C’est un contrôle d’artefact de preuve, pas
un géo-épinglage de votre trafic d’inférence.)
GET …/residency (tout membre) ; le changer est Admin.
7. Rétention, effacement et audit
Le plan de conformité est adossé aux mêmes garanties de cycle de vie des données qui s’appliquent à travers la passerelle :Rétention des logs de requête
Rétention des logs de requête
Les logs de requête sont conservés 30 jours par défaut et 180 jours
maximum — la passerelle plafonne tout ce qui est plus long. La rétention alimente
directement votre score de préparation.
Droit à l'effacement
Droit à l'effacement
Une demande de suppression de compte ouvre une période de grâce de 30 jours
(le défaut), après quoi la PII du compte est irréversiblement effacée : la cascade
redacte les identifiants sur les logs de requête conservés et purge les
correspondances de guardrail, les événements firewall, et les enregistrements de
trace d’agent scopés à l’utilisateur.
Piste d'audit
Piste d'audit
La section change-log d’un rapport de conformité est tirée du log d’audit de
l’espace de travail, scopée à la période du rapport. Les e-mails des membres et des
admins sont masqués par défaut dans le rapport exporté (par ex.
j•••@acme.com)
sauf si la PII complète est explicitement demandée au moment de la génération. Voir
le catalogue des actions d’audit.Où aller ensuite
API Guardrail
La politique du plan texte/données qu’un pack de conformité matérialise.
API Firewall
Le plan de politique d’appel d’outil que le pack écrit à côté.
Pile de contrôle
Comment guardrails, firewall et conformité se composent en une seule posture.
Codes d'erreur
Chaque statut que la passerelle peut renvoyer, y compris les barrières de paywall
et de rôle.
