Open API

In ASAP, puoi utilizzare Open API per interagire con soluzioni di terzi. Open API funziona tramite HTTP e offre una serie di metodi di richiesta/risposta.

Le richieste API devono essere inviate al seguente indirizzo:

<URL del portale ASAP, utilizzato per interagire tramite Open API>/openapi/<versione API>/<richiesta>

Ogni metodo supporta non più di 10 richieste al secondo (RPS, Requests Per Second).

Come ottenere l'URL di ASAP, utilizzato per interagire tramite l'API

Per ottenere un URL Open API di ASAP:

  1. Accedi alla piattaforma web di ASAP.
  2. Nella sezione Dashboard, fai clic sul pulsante Importazione e sincronizzazione, quindi apri la scheda Open API.
  3. Il link per contattare ASAP tramite Open API si trova nella parte inferiore della finestra. Copialo e salvalo in una posizione comoda per te.

Come abilitare l'accesso tramite l'API e generare un token

Per autorizzare le richieste, queste devono essere firmate da un token creato sulla piattaforma ASAP. Solo gli amministratori dell'azienda possono creare token.

Per creare un token:

  1. Accedi alla piattaforma web di ASAP.
  2. Nella sezione Dashboard, fai clic sul pulsante Importazione e sincronizzazione, quindi apri la scheda Open API.
  3. Fai clic sul pulsante Nuovo token.

    Viene visualizzata la finestra Ottieni token.

  4. Copia il token e salvalo in una posizione comoda per te.

Il token non viene archiviato nel sistema ASAP con accesso pubblico. Dopo aver chiuso la finestra Ottieni token, non sarà disponibile per la visualizzazione. Se hai chiuso la finestra senza copiare il token, devi fare di nuovo clic su Nuovo token al fine di generare un nuovo token.

Il token emesso è valido per 12 mesi. Allo scadere di questo periodo, il token viene revocato. Il token emesso viene revocato anche se non viene utilizzato per 6 mesi.

Autorizzazione

Il token ottenuto su ASAP deve essere aggiunto alle intestazioni di tutte le richieste dell'API. L'intestazione deve essere simile alla seguente:

Autorizzazione: Bearer <token ricevuto sulla piattaforma ASAP>

ContentType 'application/json; charset=utf-8'

Formato della risposta

JSON è il formato predefinito per le risposte alle richieste dell'API.

Esempio di una chiamata CURL

Di seguito è riportata una richiesta API a https://domain.com/, che utilizza il metodo "GET openapi/v1/groups" (ottenere un elenco di gruppi). La richiesta viene autenticata utilizzando il token e8c699c05d495566a94bbb6841894153.

curl -X GET "https://domain.com/openapi/v1/groups" -H "accept: application/json" -H "Authorization: Bearer Token:e8c699c05d495566a94bbb6841894153"

In questa sezione della guida

Metodo "POST /openapi/v1/users/info"

Metodo "GET /openapi/v1/groups"

Metodo "POST /openapi/v1/users"

Metodo "POST /openapi/v1/report"

Metodo "PATCH /openapi/v1/user/:userId"

Metodo "DELETE /openapi/v1/user/:userId"
In alto