SDKs
A Velix mantém 16 SDKs oficiais, um por linguagem, todos vivendo em code/sdk/sdk-velix-<linguagem>/ no monorepo (org VELIX-Biometrics no GitHub).
:::caution Pré-release
Todos os 16 SDKs estão em pré-release. Os 6 marcados como "Publicado" abaixo já foram confirmados rodando de ponta a ponta contra staging (harness code/sdk/test-all-sdks.sh) e estão disponíveis nos registries oficiais — mas a API pública ainda pode receber ajustes até a v1.0 estável. Os demais 10 seguem em desenvolvimento e ainda não têm pacote publicado.
:::
Todos os SDKs
| Linguagem | Pacote/distribuição | URL pública | Status | Runtime mínimo | Página |
|---|---|---|---|---|---|
| TypeScript / JavaScript | @velixbiometrics/sdk-core (npm) | npmjs.com/package/@velixbiometrics/sdk-core | ✅ Publicado | Node.js 20+ | Guia |
| Python | velix-sdk (PyPI) | pypi.org/project/velix-sdk | ✅ Publicado | Python 3.11/3.12 | Guia |
| Go | módulo Go | pkg.go.dev/github.com/VELIX-Biometrics/sdk-velix-go | ✅ Publicado | Go 1.22+ | Guia |
| Rust | velix-sdk (crate) | crates.io/crates/velix-sdk | ✅ Publicado | Rust 2021 stable | Guia |
| PHP | velixbiometrics/sdk (Composer) | packagist.org/packages/velixbiometrics/sdk | ✅ Publicado | PHP 8.1+ | Guia |
| Ruby | velix-sdk (gem) | rubygems.org/gems/velix-sdk | ✅ Publicado | Ruby 3.1+ | Guia |
| C++ | CMake (FetchContent) | github.com/VELIX-Biometrics/sdk-velix-cpp | ⏳ Pendente (vcpkg/Conan Center) | C++17 / libcurl + nlohmann/json | Guia |
| Java | com.velix:velix-sdk (Maven) | github.com/VELIX-Biometrics/sdk-velix-java | ⏳ Pendente (Sonatype/Maven Central) | Java 17+ | Guia |
| Kotlin | com.velix:velix-sdk-kotlin (Maven/Gradle) | github.com/VELIX-Biometrics/sdk-velix-kotlin | ⏳ Pendente (Sonatype/Maven Central) | Kotlin 1.9+ / JVM 17+ | Guia |
| C# / .NET | Velix.SDK (NuGet) | github.com/VELIX-Biometrics/sdk-velix-csharp | ⏳ Pendente | .NET 8+ | Guia |
| Swift | VelixSDK (Swift Package Manager) | github.com/VELIX-Biometrics/sdk-velix-swift | ⏳ Pendente (Swift Package Index) | Swift 5.9+ / iOS 16+ | Guia |
| Dart | velix_sdk (pub.dev) | github.com/VELIX-Biometrics/sdk-velix-dart | ⏳ Pendente | Dart 3.0+ / Flutter 3.10+ | Guia |
| Elixir | velix (Hex) | github.com/VELIX-Biometrics/sdk-velix-elixir | ⏳ Pendente | Elixir 1.15+ / OTP 26+ | Guia |
| Lua | velix-sdk (LuaRocks) | github.com/VELIX-Biometrics/sdk-velix-lua | ⏳ Pendente | Lua 5.1+ / LuaJIT | Guia |
| PowerShell | VelixSDK (módulo PS Gallery) | github.com/VELIX-Biometrics/sdk-velix-powershell | ⏳ Pendente | PowerShell 7.2+ | Guia |
| Delphi / Object Pascal | pacote Delphi (VelixSDK.dpk) | github.com/VELIX-Biometrics/sdk-velix-delphi | ⏳ Pendente (GetIt / distribuição manual) | Delphi XE8+ / RAD Studio | Guia |
Módulos disponíveis (todos os SDKs)
Todos os SDKs implementam a mesma superfície funcional, adaptada aos idiomas de cada linguagem:
| Módulo | Descrição |
|---|---|
Checkin | Check-in facial, QR code e manual (facial(), qrCode(), manual(), getHistory()) |
Persons | CRUD de pessoas e enroll biométrico (list(), get(), enroll(), delete()) |
Tenant | Leitura/edição de configurações do tenant |
Webhooks | Configuração e listagem de webhooks |
Variáveis de ambiente (convenção comum)
VELIX_API_URL=https://api.velixbiometrics.com
VELIX_API_KEY=vx_live_... # ou vx_sandbox_... no ambiente de testes
Repositório e suporte
Cada SDK vive isolado em code/sdk/sdk-velix-<linguagem>/ no monorepo, com seu próprio build, testes e README com instruções detalhadas. Problemas ou solicitações de features devem ser abertos no repositório do SDK correspondente no GitHub (VELIX-Biometrics).