Vendere un flipbook e leggere le vendite

Cosa puoi fare

Questi cinque endpoint coprono l'intero ciclo di vita della vendita di un flipbook e del monitoraggio di ciò che guadagna:

• Configurare la vendita — imposta prezzo, valuta e se il flipbook è in vendita.
• Personalizzare la pagina di checkout — titoli, testo dei pulsanti e colore dei pulsanti.
• Scegliere un gateway di pagamento — scegli il gateway e imposta le sue credenziali.
• Registrare un acquisto — registra una vendita completata effettuata tramite il tuo flusso di pagamento.
• Leggere le tue vendite — elenca i record di vendita completati (o di carrello abbandonato), con paginazione ed esportazione CSV.

Prima di iniziare

• Una chiave API — inviata come header X-Api-Key, o come Authorization: Bearer YOUR_API_KEY, in ogni richiesta.
• Tutte le richieste vanno all'URL di base https://go.fliplink.me.
• Ogni endpoint tranne List Sales accetta l'ID numerico del flipbook come parametro {flipbookId} nel percorso — per esempio .../set-sale-settings/96216.
• Gli endpoint di scrittura (Set Sale Settings, Set Sale Page Text, Set Sale Gateway, Set Flipbook Purchase) inviano il loro body come campi form-urlencoded (NON JSON).

Configurare la vendita

PUT /api/set-sale-settings/{flipbookId} configura la vendita del flipbook (prezzo, valuta, opzioni). Attivare la modalità di vendita abilita automaticamente la verifica email e rende obbligatoria l'email del lead.

Campi chiave:

• SaleAmount — il prezzo in unità intere di valuta (per esempio dollari), con i decimali consentiti. 9.99 significa $9.99 e 1000 significa $1,000 — NON è un valore in centesimi/unità minori.
• SaleCurr — il codice della valuta (predefinito usd). Scegli un codice valido da /api/list-currencies.

curl -X PUT 'https://go.fliplink.me/api/set-sale-settings/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsForSale=true' \
  --data-urlencode 'SaleCurr=usd' \
  --data-urlencode 'SaleAmount=9.99'

Risposta:

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Personalizzare la pagina di checkout

PUT /api/set-sale-page-text/{flipbookId} imposta i testi di marketing mostrati sulla pagina di vendita / checkout del flipbook.

curl -X PUT 'https://go.fliplink.me/api/set-sale-page-text/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'SalePageTitle=' \
  --data-urlencode 'SaleAccessPageTitle=' \
  --data-urlencode 'SalePurchaseButtonText=' \
  --data-urlencode 'SaleButtonText=' \
  --data-urlencode 'SaleAccessButtonText=' \
  --data-urlencode 'SaleButtonColor='

Risposta:

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Scegliere un gateway di pagamento

PUT /api/set-sale-gateway/{flipbookId} seleziona e configura il gateway di pagamento usato quando vendi questo flipbook.

curl -X PUT 'https://go.fliplink.me/api/set-sale-gateway/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'SaleGatewayName=' \
  --data-urlencode 'SaleGatewayKey=' \
  --data-urlencode 'SaleGatewaySecret='

Risposta:

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Registrare un acquisto

POST /api/set-flipbook-purchase/{flipbookId} registra una vendita (acquisto) completata di un flipbook — usalo per registrare acquisti effettuati tramite il tuo flusso di pagamento, senza passare per il checkout Stripe di FlipLink. Invia l'Email dell'acquirente e il riferimento del tuo gateway di pagamento PaymentRef (per Stripe, l'ID del PaymentIntent, pi_...); entrambi sono obbligatori. NON inviare Amount/Currency — quelli sono derivati lato server dal tuo riferimento di pagamento.

curl -X POST 'https://go.fliplink.me/api/set-flipbook-purchase/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'Email=customer@example.com' \
  --data-urlencode 'PaymentRef=pi_3O1234567890abcdef'

Risposta:

{
  "Result": "OK",
  "Message": "Purchase recorded successfully"
}

Leggere le tue vendite

GET /api/list-sales elenca i record di vendita/acquisto dei tuoi flipbook (email dell'acquirente, flipbook, importo, data) più le definizioni delle colonne per la tabella delle vendite. Supporta la paginazione e l'esportazione CSV tramite IsDownload. Imposta IsAbandoned=true per restituire le vendite di carrello abbandonato invece delle vendite completate.

curl -X GET 'https://go.fliplink.me/api/list-sales?ItemIDs=&SearchText=&PageNo=1&Offset=0&IsDownload=true&IsAbandoned=false' \
  -H 'X-Api-Key: YOUR_API_KEY'

Risposta:

{
  "Result": "OK",
  "Items": [],
  "Columns": [
    {
      "ID": 1,
      "data": "ID",
      "title": "ID",
      "type": "numeric",
      "hidden": true,
      "readOnly": true,
      "defaultValue": "",
      "source": "",
      "width": 0,
      "backgroundColor": "",
      "align": "left"
    }
  ],
  "TotalRecordCount": 0
}

Errori possibili

• Chiave API mancante o non valida → HTTP 401. Restituisce una semplice pagina HTML di Unauthorized — non c'è alcun body JSON. Controlla che l'header X-Api-Key sia presente e corretto.
• flipbookId sconosciuto (o non di proprietà della tua chiave) → HTTP 200 con { "Result": "ERROR", "Message": "Item not found" }. Questo vale per Set Sale Settings, Set Sale Page Text, Set Sale Gateway e Set Flipbook Purchase.
• Campo del body sconosciuto o scritto male → HTTP 200 con { "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }.
• Campo obbligatorio dell'acquisto mancante (Set Flipbook Purchase) → { "Result": "ERROR", "Message": "Email is required." } o { "Result": "ERROR", "Message": "PaymentRef is required." }.

Note

• Attivare la modalità di vendita (IsForSale) tramite Set Sale Settings abilita automaticamente la verifica email e rende obbligatoria l'email del lead.
• Set Flipbook Purchase è per gli acquisti effettuati tramite il tuo flusso di pagamento — ti permette di registrare una vendita senza passare per il checkout Stripe di FlipLink.