Panoramica dell'API aperta

Panoramica

PlanRadar fornisce API REST sicure, aperte a tutti i clienti per le loro integrazioni.
Oltre a ciò PlanRadar fornisce anche PlanRadar Connect per costruire automazioni personalizzate e integrazioni 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.

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

1. Clicchi su Impostazioni
2. Clicchi su Documentazione API
3. Inserisca la sua password
4. Clicchi su Conferma
   
5. Selezioni la funzione di cui vuole mostrare le API
   
6. 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": "Il nome del suo progetto"
      }
    }
  }

Corpo della risposta:

  {
    "dati": {
      "id": "aqbqod",
      "tipo": "progetti",
      "attributi": {
        "id": "aqbqod",
        "nome": "Nome del suo progetto",
        "homepage": "",
        "paese": null,
        "projectnumber": null,
        "descrizione": null,
        "città": null,
        "codice postale": null,
        "via": null,
        "author-id": "pxpp",
        ...
      }
    }
  }

Concetti API fondamentali

Scopra i concetti fondamentali alla base delle nostre API. Per saperne di più, consulti Concetti fondamentali delle API.

Tutorial API

Esplori i tutorial passo-passo su come utilizzare le nostre API nelle seguenti aree:

Tutorial API per gli endpoint utente

Tutorial API per gli endpoint del progetto

Tutorial API per gli endpoint di Ticket

Tutorial API per gli endpoint dei documenti

Esercitazioni API per gli endpoint di pianificazione

Changelog dell'API

Esamini gli ultimi aggiornamenti e modifiche alle nostre API. Per saperne di più, consulti il Changelog delle API di .