sdk_signer/docs/API.md

17 lines
650 B
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

## API
### Portée
- Contrats dinterface entre clients WebSocket et serveur sdk-signer.
### Contrats dinterface
- Enum MessageType: connexion, token, processus, merkle, device, erreurs.
- Messages: porteurs dun type, dun messageId, et de champs spécifiques à lopération.
- Statuts: DeliveryStatus (PENDING, SENT, DELIVERED, FAILED, RETRY).
- Priorités: MessagePriority (LOW, NORMAL, HIGH, CRITICAL).
### Erreurs et statuts
- Réponse de type ERROR en cas déchec; gestion de timeouts côté serveur/clients.
### Versionnage et compatibilité
- Alignement strict avec sdk_signer_client pour les énumérations et structures.