Usage Guides

Developer API Usage Guide

The SecureVault Developer API lets external applications create, query, encrypt, and decrypt memos programmatically via RESTful endpoints.

Step 1: Access Developer Portal

Enter /developer in the address bar, or click 'API Docs' from the 'Resources' menu. Login is required.

Step 2: Generate API Key

Click 'Generate New API Key' in the developer portal. Set a key name and permission scope. The generated key is shown only once—store it securely.

Step 3: Use the API

Include the API key as a Bearer token in the Authorization header. Key endpoints: GET /api/v1/memos (list), POST /api/v1/memos (create), POST /api/v1/encrypt (encrypt), POST /api/v1/decrypt (decrypt).

Step 4: Check Usage

View API call counts and daily/monthly usage statistics in the developer portal. Exceeding plan API limits returns 429 errors.

Step 5: API Documentation

Find the complete API reference at /developer/docs. Request/response formats, error codes, and code examples are provided for each endpoint.

Developer API Tips

  • -Never hardcode API keys—use environment variables.
  • -Delete unused API keys immediately.
  • -Check error response status codes and messages for debugging.
  • -If rate limited, wait before retrying or consider upgrading your plan.