Panoramica
PlanRadar fornisce API REST sicure, aperte a tutti i clienti per le loro integrazioni. Inoltre, PlanRadar fornisce anche PlanRadar Connect per costruire automazioni e integrazioni personalizzate con applicazioni di terze parti senza dover codificare. Per saperne di più, consulti PlanRadar Connect.
L'API REST presenta URL orientati alle risorse, accetta corpi di richiesta codificati in forma, restituisce risposte codificate in JSON e utilizza codici di risposta HTTP e autenticazione standard.
Accesso e permessi
Open APIs è disponibile solo per gli account Pro ed Enterprise. Maggiori informazioni in Prezzi e abbonamenti.
Per utilizzare le API aperte, è necessario un utente interno con l'autorizzazione 'Accesso API'. Maggiori informazioni in Permessi.
Utilizzare API aperte
Quando utilizza le API, può inviare fino a 30 richieste al minuto. Il superamento di questo limite comporta la disabilitazione del suo token di autorizzazione per 5 minuti. In caso di esigenze particolari, la preghiamo di contattare il nostro team di assistenza.
Autorizzazione all'accesso API
Quando consuma un'API, deve aggiungere la chiave di autorizzazione come valore di intestazione "X-PlanRadar-API-Key". La chiave di autorizzazione può essere ottenuta generando Personal Access Tokens e utilizzandoli per autenticare le sue richieste API.
API disponibili
- Clicchi su Impostazioni
- Clicchi su Documentazione API
- Inserisca la sua password
- Clicchi su Conferma
- Selezioni la funzione di cui vuole mostrare le API
- Verrà visualizzato un elenco di tutte le API relative a quella funzione
Attualmente stiamo lavorando per aggiornare tutte le nostre API alla versione v2. Raccomandiamo di utilizzare le API v2, se disponibili. Le API V2 sono più veloci, robuste e flessibili delle API v1.
Esempio di richiesta API
Ecco un esempio di utilizzo delle API per richiamare i dettagli del progetto:
URL API:
GET /api/v1/{customer_id}/progetti
Corpo della richiesta:
{
"dati": {
"attributi": {
"nome": "Nome del suo progetto"
}
}
}
Corpo della risposta:
{
"dati": {
"id": "aqbqod",
"tipo": "progetti",
"attributi": {
"id": "aqbqod",
"nome": "Nome del suo progetto",
"homepage": "",
"country": null,
"projectnumber": null,
"description": null,
"city": null,
"zipcode": null,
"street": null,
"author-id": "pxpp",
...
}
}
}
Commenti
0 commenti
Accedi per aggiungere un commento.