feat: rebrand Hemmelig to paste.es for cloudhost.es
- Set Spanish as default language with ephemeral/encrypted privacy focus - Translate all user-facing strings and legal pages to Spanish - Replace Norwegian flag with Spanish flag in footer - Remove Hemmelig/terces.cloud links, add cloudhost.es sponsorship - Rewrite PrivacyPage: zero data collection, ephemeral design emphasis - Rewrite TermsPage: Spanish law, RGPD, paste.es/CloudHost.es references - Update PWA manifest, HTML meta tags, package.json branding - Rename webhook headers to X-Paste-Event / X-Paste-Signature - Update API docs title and contact to paste.es / cloudhost.es Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
This commit is contained in:
77
docs/sdk.md
Normal file
77
docs/sdk.md
Normal file
@@ -0,0 +1,77 @@
|
||||
# SDK Generation
|
||||
|
||||
> **Disclaimer:** The Hemmelig API is subject to change without notice. Generated SDKs may break with future updates. Use at your own risk.
|
||||
|
||||
Hemmelig exposes an OpenAPI 3.0 specification that can be used to generate client SDKs in various programming languages.
|
||||
|
||||
## OpenAPI Specification
|
||||
|
||||
The OpenAPI spec is available at:
|
||||
|
||||
- **Swagger UI:** `/api/docs` - Interactive API explorer
|
||||
- **OpenAPI JSON:** `/api/openapi.json` - Raw specification
|
||||
|
||||
## Generating an SDK
|
||||
|
||||
We recommend using [OpenAPI Generator](https://openapi-generator.tech/) which supports 50+ languages.
|
||||
|
||||
### Installation
|
||||
|
||||
```bash
|
||||
npm install -g @openapitools/openapi-generator-cli
|
||||
```
|
||||
|
||||
### Generate SDK
|
||||
|
||||
```bash
|
||||
# TypeScript
|
||||
openapi-generator-cli generate \
|
||||
-i https://your-instance.com/api/openapi.json \
|
||||
-g typescript-axios \
|
||||
-o ./hemmelig-sdk
|
||||
|
||||
# Python
|
||||
openapi-generator-cli generate \
|
||||
-i https://your-instance.com/api/openapi.json \
|
||||
-g python \
|
||||
-o ./hemmelig-sdk
|
||||
|
||||
# Go
|
||||
openapi-generator-cli generate \
|
||||
-i https://your-instance.com/api/openapi.json \
|
||||
-g go \
|
||||
-o ./hemmelig-sdk
|
||||
```
|
||||
|
||||
View all available generators:
|
||||
|
||||
```bash
|
||||
openapi-generator-cli list
|
||||
```
|
||||
|
||||
## Authentication
|
||||
|
||||
The API supports two authentication methods:
|
||||
|
||||
### Bearer Token (API Key)
|
||||
|
||||
```typescript
|
||||
const client = new HemmeligApi({
|
||||
baseURL: 'https://your-instance.com/api',
|
||||
headers: {
|
||||
Authorization: 'Bearer hemmelig_your_api_key_here',
|
||||
},
|
||||
});
|
||||
```
|
||||
|
||||
### Session Cookie
|
||||
|
||||
For browser-based applications, session cookies are automatically handled after authentication via `/auth` endpoints.
|
||||
|
||||
## Important: Client-Side Encryption
|
||||
|
||||
Generated SDKs handle API communication only. **You must implement client-side encryption** before sending secrets to the API.
|
||||
|
||||
Hemmelig uses AES-256-GCM encryption. See the [encryption documentation](./encryption.md) for implementation details.
|
||||
|
||||
The decryption key should be passed via URL fragments (`#decryptionKey=...`) which are never sent to the server.
|
||||
Reference in New Issue
Block a user