Vai al contenuto

Client

Per lavorare con l'Amica Cloud API serve un client capace di interagire con essa. Puoi usare uno dei nostri SDK ufficiali, generare un client nel tuo linguaggio dalla specifica OpenAPI, oppure usare un client HTTP generico come curl o Postman.

SDK ufficiali

Gli SDK ufficiali sono generati automaticamente dalla specifica OpenAPI dell'Amica Cloud API e aggiornati a ogni rilascio, così restano sempre allineati all'API. Ognuno espone i modelli e i metodi dell'API e gestisce serializzazione e chiamate HTTP; a tuo carico resta solo l'autenticazione (header Authorization: Bearer <token>).

Linguaggio Pacchetto Repository
C# / .NET Amica.Sdk amica-dev/csharp-sdk
Python amica_python_sdk amica-dev/python-sdk
TypeScript @amica/typescript-sdk amica-dev/typescript-sdk
PHP amica/php-sdk amica-dev/php-sdk

Installazione

A ogni rilascio dell'API, ciascun SDK viene rigenerato, taggato (vX.Y.Z) e pubblicato come GitHub Release nel rispettivo repository, con allegati gli artefatti compilati. Negli esempi seguenti sostituisci v3.0.0 con l'ultima versione disponibile nella pagina Releases del repo.

NuGet non installa direttamente da Git. Scarica il pacchetto Amica.Sdk.<versione>.nupkg allegato alla Release in una cartella locale, poi aggiungila come sorgente:

dotnet add package Amica.Sdk --version 3.0.0 --source ./percorso/cartella-nupkg

Installa direttamente dal repository, fissando il tag della release:

pip install git+https://github.com/amica-dev/python-sdk.git@v3.0.0

In alternativa, installa la wheel allegata alla Release.

Installa dal repository fissando il tag della release:

npm install github:amica-dev/typescript-sdk#v3.0.0

In alternativa, scarica il tarball .tgz allegato alla Release e installalo con npm install ./amica-typescript-sdk-3.0.0.tgz.

Con Composer, aggiungi il repository VCS e richiedi il pacchetto. Nel tuo composer.json:

{
  "repositories": [
    { "type": "vcs", "url": "https://github.com/amica-dev/php-sdk" }
  ],
  "require": {
    "amica/php-sdk": "^3.0"
  }
}

poi esegui composer update.

Packaging sui registry pubblici

In questa fase la distribuzione avviene tramite GitHub Releases. La pubblicazione sui registry pubblici (NuGet, PyPI, npm, Packagist) è prevista più avanti.

Generare un client per altri linguaggi

Se il tuo linguaggio non è tra quelli sopra, puoi generare un client tipizzato dalla specifica OpenAPI con OpenAPI Generator (supporta decine di linguaggi):

openapi-generator-cli generate \
  -i https://customerws1.amica20.it/api/v3/swagger.json \
  -g <linguaggio> \
  -o ./amica-client

Strumenti per provare l'API

  • curl — chiamate HTTP da riga di comando.
  • Postman — importa la specifica OpenAPI e provala dall'interfaccia grafica.
  • API Reference interattiva — prova gli endpoint direttamente dal browser.