Skip to main content

​
Publishing Partner Docs and SDK

​
First Release Scope

The first partner release is SDK-first and admin-approved:
  1. Partner requests access from Sweepr.
  2. Sweepr reviews origin, app, payout wallet, and expected volume.
  3. Sweepr creates the partner profile and API key.
  4. Partner receives the key through a secure channel.
  5. Partner integrates with @sweepr/sdk.
  6. Partner verifies in sandbox or preview before production.
Self-service key creation and a partner dashboard are intentionally out of scope for the first release. Use one docs domain and the npm SDK: 
docs.sweepr.co                 Public app docs and partner guides
api.sweepr.co/sweepr           Swagger/OpenAPI UI from backend
@sweepr/sdk                    TypeScript partner SDK
When the production backend exposes /sweepr/openapi.json, Mintlify can render generated API reference inside the same docs site.

​
SDK Publishing

Publishing @sweepr/sdk is recommended once the V2 response shape and V5 ABI are stable. Initial package: 
@sweepr/sdk@0.1.0
Keep it marked as beta until the first production partner integration is complete.

​
NPM Release Checklist

  1. Confirm package name availability.
  2. Confirm package metadata: description, license, repository, author.
  3. Build dist.
  4. Run SDK typecheck.
  5. Verify README quickstart.
  6. Publish with provenance if available.
  7. Tag release in GitHub.
cd sdk
npm publish --access public

​
API Key Handling

Partners should not self-generate API keys in the first release. Sweepr issues keys and stores only hashed keys in the backend. Raw keys are shown once and should be sent through a secure channel.
Last modified on June 14, 2026