SDKs e CLI
SDKs oficiais são wrappers finos sobre a API pública. O CLI é o mesmo motor que roda em produção, exposto para testes locais.
Os SDKs são wrappers finos sobre a API pública — TypeScript e Python — e o CLI é o mesmo motor que roda em produção, exposto para testes locais. Nada no cliente reimplementa comportamento da plataforma.
Escolha a superfície que serve ao trabalho: o SDK para chamadas tipadas em processo, o CLI para scripts de shell e etapas de CI.
Como toda superfície espelha o mesmo contrato REST, migrar entre elas é mecânico: uma requisição que funciona na CLI funciona sem alterações em qualquer SDK com o mesmo token e o mesmo corpo JSON.
Linguagens
- TypeScript: `npm i @doesitdefend/sdk` (Node 20+).
- Python: `pip install doesitdefend` (Python 3.11+).
- CLI: `npm i -g @doesitdefend/cli` (Node 20+).
As versões mínimas fazem parte do contrato: Node 20+ para o SDK TypeScript e o CLI, Python 3.11+ para o SDK Python. Instale dos registros públicos — npm e PyPI — sob o escopo @doesitdefend.
Fixe as versões dos pacotes no CI como qualquer outra dependência. Os wrappers acompanham a API pública em vez de bifurcar comportamento, então os tipos com que você compila permanecem alinhados ao contrato da plataforma.
Uso
- Auth via env var `DID_API_TOKEN`.
- CLI espelha a API um-para-um: `did runs create --profile=quick`.
- SDK TypeScript entrega tipos para cada response shape (validados com Zod).
A autenticação lê DID_API_TOKEN do ambiente em vez de flags ou arquivos de configuração. O CLI espelha a API um-para-um (did runs create --profile=quick), e o SDK TypeScript entrega tipos validados com Zod para cada formato de resposta.
A convenção de variável de ambiente mantém credenciais fora de shells, flags e config versionada: defina DID_API_TOKEN uma vez por ambiente e todas as superfícies a leem.