35 lines
445 B
Markdown
35 lines
445 B
Markdown
# API Conventions v0.1
|
|
|
|
## Grundprinzip
|
|
|
|
Die REST API soll konsistent und verständlich aufgebaut sein.
|
|
|
|
## Versionierung
|
|
|
|
- /api/v1/
|
|
|
|
## Ressourcenbeispiele
|
|
|
|
- /customers
|
|
- /contracts
|
|
- /domains
|
|
- /hosting-packages
|
|
- /servers
|
|
- /invoices
|
|
- /tickets
|
|
- /documents
|
|
|
|
## Antworten
|
|
|
|
API-Antworten sollen konsistent sein:
|
|
- data
|
|
- meta
|
|
- errors
|
|
|
|
## Sicherheit
|
|
|
|
- Authentifizierung erforderlich
|
|
- Rechteprüfung je Ressource
|
|
- Rate-Limiting
|
|
- API-Logs
|