Che cos'è l'API Pubblica di Agicap?

L'API Pubblica consente a te e ai tuoi integratori o partner di sviluppare integrazioni tecniche con Agicap. Ti permette di automatizzare lo scambio di dati tra applicazioni, consentendo un'integrazione senza soluzione di continuità con i tuoi strumenti esistenti.

Perché utilizzare l'API Pubblica?

Ecco alcuni vantaggi immediati dell'utilizzo dell'API Pubblica:

Sicurezza migliorata: Le nostre API sono protette da un flusso di credenziali client. Ogni organizzazione deve generare le proprie credenziali dall'app Agicap prima di iniziare a utilizzare l'API. È più sicuro poiché ogni servizio utilizza credenziali uniche.
Prestazioni aumentate: La nostra soluzione può gestire fino a 4000 richieste al secondo, consentendo alle tue integrazioni di scalare senza temere interruzioni dell'API.
Coerenza: Abbiamo definito linee guida per l'API di Agicap per garantire che tutte le nostre API esposte abbiano implementazioni standardizzate.

A lungo termine, l'API Pubblica abiliterà casi d'uso che non erano possibili con la nostra precedente Open API:

Monitoraggio completo: Monitora il consumo dell'API da parte dei clienti configurati e dei loro endpoint.
Capacità di impersonificazione dell'utente: Consenti chiamate API come utente all'interno di un sistema di credenziali client, abilitando attività automatizzate come l'assegnazione di un utente a un'entità quando viene aggiunto alla tua Active Directory.

Come iniziare con l'API Pubblica

1. Accedi alla documentazione dell'API Pubblica

La documentazione dell'API Pubblica è disponibile su https://api.agicap.com/. Qui troverai informazioni dettagliate su come effettuare richieste API.

2. Genera le tue credenziali API

Solo gli utenti Admin dell'organizzazione possono generare chiavi API dai Parametri Avanzati nell'app Agicap. Altri utenti possono visualizzare le credenziali esistenti ma non possono generarne di nuove o eliminare quelle esistenti.

Per generare credenziali API:

Vai su Parametri Avanzati nel tuo account Agicap.
Seleziona Impostazioni API.
Clicca su Genera Nuove Credenziali.
Nota: Per motivi di sicurezza, il segreto del client verrà mostrato solo una volta al momento della generazione. Assicurati di conservarlo in modo sicuro.

👍 Si consiglia di utilizzare un set unico di chiavi API per ogni strumento, integratore o partner.

3. Autentica le tue richieste API

L'autenticazione è gestita tramite chiavi API e richiede un token di accesso temporaneo. Puoi recuperare questo token utilizzando la richiesta di autenticazione e le tue chiavi API.

Ogni richiesta deve includere questo token di accesso.

4. Effettuare richieste API

Le richieste API sono organizzate in domini e prodotti:

Domini API: Si riferiscono al contesto aziendale generale.
Prodotti API: Si riferiscono a oggetti specifici o insiemi di oggetti correlati con cui interagire.

La maggior parte delle richieste viene effettuata per recuperare dati per una determinata organizzazione o entità.

L'ID dell'organizzazione può essere recuperato dalla pagina delle impostazioni API.
L'ID dell'entità può essere recuperato tramite la richiesta elenco entità.

Puoi:

Recuperare dati da Agicap per aggiornare i tuoi strumenti.
Inviare, aggiornare o eliminare dati in Agicap.

5. Esplora gli endpoint API

Visita https://api.agicap.com/apis per vedere gli endpoint disponibili e le azioni che puoi eseguire tramite l'API Pubblica.

💡 Consigli

Mantieni le tue credenziali al sicuro: Il tuo segreto del client viene mostrato solo una volta. Conservalo in modo sicuro.
Usa credenziali uniche: Genera chiavi API separate per ogni servizio o integrazione per una maggiore sicurezza.
Controlla la documentazione: Fai sempre riferimento a https://api.agicap.com/ per le informazioni più aggiornate.

Q&A ❓

Qual è la differenza tra l'API Pubblica e l'Open API?

Fai attenzione a non confondere Open API e API Pubblica; sono due cose diverse:

Open API: Ti consente di creare connessioni Business e Banking (principalmente tramite AFT) ed è gestita dal team di Integrazione Dati. Gli endpoint iniziano con openapi.agicap.com.
API Pubblica: Ti consente di inviare e recuperare vari dati da Agicap in modo sicuro ed efficiente. Gli endpoint iniziano con api.agicap.com.

L'API Pubblica offre sicurezza, prestazioni e nuove capacità migliorate non disponibili con l'Open API.

Come posso migrare dall'Open API all'API Pubblica?

Il nostro obiettivo è quello di trasferire tutti i casi d'uso all'API Pubblica. Contatteremo i clienti che utilizzano ancora l'Open API una volta che tutti i casi d'uso saranno coperti sull'API Pubblica.

Posso ricevere assistenza per configurare l'API Pubblica?

I clienti dovrebbero essere autonomi nella configurazione dell'API Pubblica seguendo le istruzioni sul sito pubblico https://api.agicap.com/. Se hai bisogno di ulteriore assistenza, faccelo sapere.