Documentazione API

L'API REST di DragApp ti permette di interagire in modo programmatico con bacheche, colonne, schede, etichette e sequenze email. Crea integrazioni, automatizza i flussi di lavoro e sincronizza Drag con gli strumenti che usi già.


Autenticazione

L'API di DragApp usa chiavi API per autenticare le richieste. Includi la tua chiave API nell'intestazione Autorizzazione di ogni richiesta.

La tua chiave API si trova in Impostazioni, all'interno di Drag. Se non hai un account, registrati qui.

Esempio di richiesta
curl --request GET \
  --url https://app.dragapp.com/v2/board \
  --header 'Authorization: YOUR_API_KEY'

Tieni al sicuro la tua chiave API. Non condividerla pubblicamente e non salvarla in un sistema di controllo versione.


URL di base

Tutti gli endpoint sono relativi a questo URL di base:

https://app.dragapp.com/v2/

Formato della risposta

Tutte le risposte restituiscono JSON con una struttura coerente. I codici nell'intervallo 200 indicano un esito positivo. I codici nell'intervallo 400 indicano un errore nella richiesta.

Successo
{
  "message": "Success message",
  "error": false,
  "code": 200,
  "data": { ... }
}
Errore
{
  "message": "Error message",
  "code": 400,
  "error": true
}

Codici di stato HTTP

CodiceDescrizione
200OK. Richiesta riuscita.
400Richiesta non valida. Parametri non validi.
401Non autorizzato. Chiave API non valida o mancante.
403Accesso negato. Autorizzazioni insufficienti.
404Non trovato. La risorsa non esiste.
429Limite di richieste superato. Troppe richieste.
500Errore del server. Qualcosa è andato storto da parte nostra.

Bacheche

Le bacheche sono i contenitori di primo livello in Drag. Ogni bacheca corrisponde a una casella di posta condivisa o a uno spazio di lavoro per le attività in Gmail.

GET/v2/board
Elenca tutte le bacheche
GET/v2/board/:id
Recupera una singola bacheca
POST/v2/board
Crea una bacheca

Crea bacheca

Crea una bacheca nel tuo Gmail.

Parametri

NomestringObbligatorio

Nome della bacheca

Esempio: "Bacheca assistenza"

UtentilistFacoltativo

Elenco delle email degli utenti

Esempio: ["aj@dragapp.com"]

Risposta
{
  "message": "Board created successfully",
  "error": false,
  "code": 200,
  "data": {
    "Id": 404303,
    "BoardName": "Testing V2 Board"
  }
}

Elenca bacheche

Elenca tutti i tipi di bacheca.

Nessun parametro.

Risposta
{
  "message": "Board list",
  "error": false,
  "code": 200,
  "data": [
    {
      "Id": 162461,
      "Name": "A's Inbox",
      "Owner": "aj@dragapp.com",
      "Users": "akdev013@gmail.com"
    }
  ]
}

Recupera bacheca

Recupera i dettagli di una singola bacheca.

Nessun parametro nel corpo. Passa l'ID della bacheca nel percorso dell'URL.

Risposta
{
  "message": "Board details",
  "error": false,
  "code": 200,
  "data": {
    "Id": 162461,
    "Name": "A's Inbox",
    "Owner": "aj@dragapp.com",
    "Users": "akdev013@gmail.com"
  }
}

Colonne

Le colonne rappresentano le fasi della tua bacheca Kanban (ad esempio Da fare, In corso, Fatto). Ogni colonna appartiene a una bacheca.

GET/v2/board/:boardId/columns
Elenca tutte le colonne di una bacheca
GET/v2/board/:boardId/column/:id
Recupera una singola colonna
GET/v2/board/:boardId/column/:columnId/cards
Elenca tutte le schede di una colonna
POST/v2/board/:boardId/column
Crea una colonna

Crea colonna

Crea una colonna in una bacheca.

Parametri

NomestringObbligatorio

Nome della colonna

Esempio: "Da fare"

Risposta
{
  "message": "Column created successfully",
  "error": false,
  "code": 200,
  "data": {
    "Success": "Column created successfully."
  }
}

Elenca colonne

Elenca tutte le colonne di una bacheca.

Nessun parametro nel corpo.

Risposta
{
  "message": "Columns list",
  "error": false,
  "code": 200,
  "data": [
    { "Id": 158415, "ColumnId": "Label_1", "Name": "To Do" },
    { "Id": 158416, "ColumnId": "Label_2", "Name": "Doing" },
    { "Id": 158417, "ColumnId": "Label_3", "Name": "Done" }
  ]
}

Elenca schede nella colonna

Elenca tutte le schede di una colonna. Supporta la paginazione.

Parametri

pagenumberObbligatorio

Numero di pagina

Esempio: 1

limitstringFacoltativo

Numero di schede per pagina

Esempio: "10"

Risposta
{
  "message": "Column cards",
  "error": false,
  "code": 200,
  "data": [
    {
      "DragTaskId": 200442,
      "TaskName": "Task",
      "ReadUnreadStatus": 1,
      "ColumnId": "Label_1",
      "BoardId": 404302,
      "DueDate": null,
      "Assignees": null,
      "ThreadOwnerEmail": "aj@dragapp.com",
      "CreatedAt": "2023-10-31T04:38:31.000Z",
      "Status": "1",
      "CustomFields": "[{}]"
    }
  ]
}

Schede

Le schede rappresentano singole attività o thread di email su una bacheca. Le schede possono avere note, commenti, sottoattività, etichette e assegnatari.

GET/v2/card/:id
Recupera i dettagli della scheda
POST/v2/card
Crea una scheda
PUT/v2/card/:cardId
Aggiornare una scheda
POST/v2/card/move-card
Sposta la scheda in un'altra colonna o bacheca
DELETE/v2/card/:cardId
Archivia una scheda
POST/v2/card/:cardId/note
Aggiungi una nota a una scheda
POST/v2/card/:cardId/tags
Aggiunge un’etichetta a una scheda
POST/v2/card/:cardId/sub-task
Aggiungi una sottoattività a una scheda

Crea scheda

Crea una scheda in una bacheca.

Parametri

BoardIdnumberObbligatorio

Bacheca in cui vuoi aggiungere la scheda

Esempio: 20841

ColumnIdnumberObbligatorio

Colonna della bacheca in cui vuoi aggiungere la scheda

Esempio: 1094

CardTitlestringObbligatorio

Titolo della scheda

Esempio: "Attività di pianificazione"

NotastringFacoltativo

Nota da aggiungere alla scheda

CommentostringFacoltativo

Commento da aggiungere alla scheda

SottoattivitàstringFacoltativo

Sottoattività da aggiungere alla scheda

AssegnatariolistFacoltativo

Email dell'assegnatario, oppure null per rimuovere l'assegnazione

Esempio: ["aj@dragapp.com"]

ReadStatusnumberFacoltativo

Letto = 1, Non letto = 0. Il valore predefinito è Letto.

Esempio: 1

Risposta
{
  "Error": false,
  "Success": "Task Added Successfully",
  "taskId": 200433
}

Aggiorna scheda

Aggiorna una scheda esistente.

Parametri

BoardIdnumberObbligatorio

Bacheca in cui si trova la scheda

Esempio: 20841

ColumnIdnumberObbligatorio

Colonna della bacheca in cui si trova la scheda

Esempio: 1094

CardTitlestringObbligatorio

Titolo della scheda

Esempio: "Attività di pianificazione"

NotastringFacoltativo

Nota per la scheda

CommentostringFacoltativo

Commento per la scheda

SottoattivitàstringFacoltativo

Sottoattività per la scheda

AssegnatariolistFacoltativo

Email dell'assegnatario, oppure null per rimuovere l'assegnazione

Esempio: ["aj@dragapp.com"]

Risposta
{
  "message": "Card updated successfully.",
  "error": false,
  "code": 200,
  "data": "2451"
}

Sposta scheda

Sposta una scheda in un'altra colonna o in un'altra bacheca.

Parametri

IdstringObbligatorio

Scheda da spostare

Esempio: "18ac0539048b4d0d"

NewBoardIdnumberFacoltativo

Bacheca in cui vuoi spostare la scheda

Esempio: 1094

NewColumnIdnumberObbligatorio

Colonna della bacheca in cui vuoi spostare la scheda

Esempio: 1094

NewPositionnumberObbligatorio

Posizione nella colonna in cui vuoi spostare la scheda

Esempio: 0

Risposta
{
  "message": "Card moved successfully.",
  "error": false,
  "code": 200,
  "data": "success"
}

Aggiungi nota

Aggiunge una nota a una scheda.

Parametri

CorpostringObbligatorio

Nota da aggiungere alla scheda

Risposta
{
  "message": "Note added to card successfully.",
  "error": false,
  "code": 200,
  "data": { "CardId": "200429" }
}

Aggiungi etichetta alla scheda

Aggiunge un’etichetta a una scheda.

Parametri

TagIdstringObbligatorio

Etichetta da aggiungere alla scheda

Esempio: "77155"

Risposta
{
  "message": "Added tag to card successfully.",
  "error": false,
  "code": 200,
  "data": { "CardId": "200429" }
}

Aggiungi sottoattività

Aggiunge una sottoattività a una scheda.

Parametri

CorpostringObbligatorio

Sottoattività da aggiungere alla scheda

Esempio: "Sottoattività 1"

Risposta
{
  "message": "SubTask added to card successfully.",
  "error": false,
  "code": 200,
  "data": { "CardId": "200429" }
}

Archivia scheda

Archivia (elimina) una scheda.

Nessun parametro nel corpo. Passa l'ID della scheda nel percorso dell'URL.

Risposta
{
  "message": "Card archived successfully.",
  "error": false,
  "code": 200,
  "data": { "id": "43813" }
}

Commenti

I commenti sono messaggi interni del team allegati alle schede.

POST/v2/comment
Aggiungi un commento a una scheda
GET/v2/comment/:commentId
Recupera un commento
PUT/v2/comment/:commentId
Aggiornare un commento
DELETE/v2/comment/:commentId
Elimina un commento

Aggiungi commento

Parametri

CardIdstringObbligatorio

Scheda a cui vuoi aggiungere il commento

Esempio: "77155"

CorpostringObbligatorio

Commento da aggiungere alla scheda

Risposta
{
  "message": "Comment created successfully.",
  "error": false,
  "code": 200,
  "data": {
    "Error": false,
    "Success": "Comment added successfully",
    "CommentDetails": {
      "CommentId": 549007,
      "UserId": 1000075,
      "Comment": "Hello comment added",
      "EntityId": "200428",
      "CreatedAt": "2023-10-29T11:29:35.000Z"
    }
  }
}

Aggiorna commento

Parametri

CorpostringObbligatorio

Commento da aggiornare

Risposta
{
  "message": "Comment updated successfully.",
  "error": false,
  "code": 200,
  "data": {
    "Error": false,
    "Success": "Comment updated successfully",
    "CommentDetails": {
      "CommentId": 549002,
      "Comment": "updating 1 existing comment",
      "EntityId": "200428",
      "CreatedAt": "2023-10-08T12:32:26.000Z"
    }
  }
}

Etichette

Le etichette sono contrassegni colorati che si possono applicare alle schede per categorizzarle e filtrarle.

GET/v2/tag
Elenca le etichette di una bacheca
POST/v2/tag
Crea un'etichetta
DELETE/v2/tag
Elimina un'etichetta

Elenca etichette

Elenca tutte le etichette di una bacheca.

Parametri

BoardIdnumberObbligatorio

Bacheca da cui vuoi ottenere le etichette

Esempio: 20841

Risposta
{
  "message": "Tag list fetched successfully.",
  "error": false,
  "code": 200,
  "data": [
    { "Id": 77163, "Name": "Tag 1", "Color": "8", "BoardId": 20841 },
    { "Id": 77164, "Name": "Tag 2", "Color": "1", "BoardId": 20841 }
  ]
}

Crea etichetta

Parametri

BoardIdnumberObbligatorio

Bacheca in cui vuoi creare l'etichetta

Esempio: 20841

NomestringObbligatorio

Nome dell'etichetta

Esempio: "In sospeso"

ColorenumberObbligatorio

Colore dell'etichetta

Risposta
{
  "message": "Tag crated successfully.",
  "error": false,
  "code": 200,
  "data": {
    "Id": 77162,
    "Name": "Tag 3 API 2",
    "Color": "11",
    "Description": null,
    "BoardId": 3007,
    "UserId": 1000075
  }
}

Elimina etichetta

Parametri

BoardIdnumberObbligatorio

Bacheca in cui è stata creata l'etichetta

Esempio: 20841

TagIdnumberObbligatorio

ID etichetta

Esempio: 77162

Risposta
{
  "message": "Tag deleted successfully.",
  "error": false,
  "code": 200,
  "data": { "Id": 77162 }
}

Sequenze email

Le sequenze email sono catene automatiche di email di follow-up che puoi programmare e monitorare.

GET/v2/email-sequence
Elenca tutte le sequenze email
GET/v2/email-sequence/:id
Recupera una sequenza email

Elenca tutto

Nessun parametro.

Risposta
{
  "EmailTemplateId": 153783,
  "UserId": 1000075,
  "Name": "Welcome Email Sequence",
  "CreatedAt": "2023-11-02T15:59:00.000Z",
  "Content": "<p>Hello {{firstName}}, ...</p>",
  "Subject": "Welcome Email",
  "EmailFollowupId": 8393,
  "TotalViewCount": 0,
  "LastSent": null,
  "OwnerName": "A J",
  "OwnerEmail": "aj@dragapp.com"
}

Recupera sequenza email

Recupera una singola sequenza email con tutti i passaggi di follow-up.

Nessun parametro nel corpo. Passa l'ID della sequenza nel percorso dell'URL.

Risposta
{
  "Id": "153783",
  "Name": "Welcome Email Sequence",
  "CreatedAt": "2023-11-02T15:59:00.000Z",
  "EmailFollowups": [
    {
      "EmailFollowupId": 8393,
      "Subject": "Welcome Email",
      "Content": "<p>Hello {{firstName}}, ...</p>",
      "Days": 1,
      "Duration": "days",
      "Hours": 3,
      "Minutes": 30,
      "Sequence": 1
    },
    {
      "EmailFollowupId": 8394,
      "Subject": "Re: Welcome Email",
      "Days": 1,
      "Duration": "days",
      "Sequence": 2
    }
  ]
}

Limiti di richieste

I limiti di richieste si applicano a tutti gli endpoint dell'API. Se ricevi un 429 come codice di stato, riduci la frequenza delle richieste e riprova con backoff esponenziale.


SDK e strumenti


Serve aiuto?

Centro assistenza: guide, tutorial e domande frequenti

Documentazione API integrata nell'app: riferimento interattivo dell’API nel tuo account DragApp

support@dragapp.com: contatta direttamente il team