Vai al contenuto principale

Configurazione dei webhook

Tutti i post creati tramite Predis.ai API hanno un ciclo di vita e assumono stati diversi. I possibili stati che un post può assumere sono inProgress, completed e error. Una volta effettuata una richiesta per generare un post, il file inProgress lo stato viene notificato nella risposta stessa. I restanti due stati - completed e error verrà avvisato tramite i webhook da te configurati.

Imposta un URL webhook

Segui i passaggi seguenti per impostare l'URL del webhook nel file API pannello di controllo:

  • Login per Predis.ai App
  • Vai a Prezzi e account -> Riposo API per aprire il API cruscotto
  • Aggiungi l'URL del tuo webhook. Assicurati che l'URL del webhook sia un URL pubblico.

Carico utile del webhook

Se il post ha raggiunto a completed or error state, verrà inviato un webhook con il payload contenente i seguenti parametri:

completed carico utile dello Stato

{
    "status": "completed",
    "caption": "...",
    "post_id": "...",
    "generated_media": [{"url": "..."}],
    "brand_id": "..."
}

error carico utile dello Stato

{
    "status": "error",
    "post_id": "..."
}
cautela

Invieremo il webhook esattamente una volta per ogni post anche se riceviamo una risposta non riuscita dai tuoi server. Nel caso in cui i tuoi server non riescano a gestire l'evento webhook, puoi ottenere i dati di tutti i post generati. Leggi di più a riguardo Qui.

Test sull'ambiente locale

Non è possibile utilizzare localhost direttamente per ricevere gli stati del webhook poiché l'URL del webhook deve essere un URL pubblico. Puoi gestirlo creando un tunnel sul tuo server locale utilizzando strumenti come Ngrok. Utilizza l'endpoint URL generato da questi strumenti nell'URL del webhook durante la configurazione dell'URL del webhook nel dashboard.

Risorse addizionali