Come iniziare

Avvio Rapido

Inizia a usare l'API Italianonprofit in pochi minuti

Questa guida ti aiuterà a fare la tua prima chiamata API in pochi minuti.

Prerequisiti

  • Un account utente su Italianonprofit
  • Accesso a un client HTTP (curl, Postman, o simile)
  • Conoscenza base di REST APIs

Passo 1: Ottieni le Credenziali

Per autenticare le tue richieste, hai due opzioni:

Opzione A: PASETO Token (per utenti)

  1. Effettua login tramite l'endpoint di autenticazione:
curl -X POST https://nitro.italianonprofit.it/api/v1/auth/login \
  -H "Content-Type: application/json" \
  -d '{
    "email": "tuo@email.com",
    "password": "tua-password"
  }'
  1. La risposta contiene accessToken e refreshToken:
{
  "status": "success",
  "data": {
    "accessToken": "v4.public.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ...",
    "refreshToken": "v4.public.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ...",
    "expiresIn": 3600
  }
}

Opzione B: API Key (per servizi)

  1. Crea una nuova API Key:
curl -X POST https://nitro.italianonprofit.it/api/v1/api-keys \
  -H "Authorization: Bearer <tuo-access-token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "My Integration",
    "scopes": ["organizations:read"]
  }'
  1. Salva la chiave restituita (visibile solo una volta):
{
  "status": "success",
  "data": {
    "key": "npf_a1b2c3d4_e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0u1v2w3x4y5z6",
    "scopes": ["organizations:read"]
  }
}
Salva la chiave API in un posto sicuro! Non sarà più visibile dopo la creazione.

Passo 2: Fai la Tua Prima Richiesta

Ora puoi autenticare le tue richieste usando il token o l'API key.

Esempio: Ricerca Organizzazioni

Ecco un esempio pratico di ricerca organizzazioni usando un token PASETO:

curl -X POST https://nitro.italianonprofit.it/api/v1/organizations/search \
  -H "Authorization: Bearer <tuo-access-token>" \
  -H "Content-Type: application/json" \
  -d '{
    "index": "db-organizations*",
    "body": {
      "query": {
        "match": {
          "name": "associazione"
        }
      }
    }
  }'

Oppure usando un'API Key:

curl -X POST https://nitro.italianonprofit.it/api/v1/organizations/search \
  -H "Authorization: Bearer npf_a1b2c3d4_e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0u1v2w3x4y5z6" \
  -H "Content-Type: application/json" \
  -d '{
    "index": "db-organizations*",
    "body": {
      "query": {
        "match": {
          "name": "associazione"
        }
      }
    }
  }'

Passo 3: Leggi la Risposta

Le risposte seguono sempre lo stesso formato:

Risposta di Successo

{
  "status": "success",
  "data": {
    "id": 123,
    "name": "Esempio Organizzazione",
    "tax_code": "12345678901"
  },
  "meta": {
    "requestId": "uuid-unico",
    "timestamp": "2024-01-15T10:30:00.000Z"
  }
}

Risposta di Errore

{
  "status": "error",
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Token non valido o scaduto",
    "details": {}
  },
  "meta": {
    "requestId": "uuid-unico",
    "timestamp": "2024-01-15T10:30:00.000Z"
  }
}

Esempi Pratici

Ricerca Avanzata Organizzazioni

Per maggiori dettagli e esempi avanzati di ricerca, consulta la documentazione completa dell'endpoint di ricerca.

Prossimi Passi

Ora che hai fatto la tua prima chiamata:

  1. Esplora l'Endpoint di Ricerca: Consulta la documentazione completa dell'endpoint di ricerca per esempi avanzati
  2. Capisci l'Autenticazione: Leggi le guide complete su PASETO tokens e API Keys
  3. Gestisci i Token: Impara a gestire il ciclo di vita dei token
  4. Gestisci gli Errori: Impara a gestire errori e codici di stato

Risorse Utili