Riferimento API

Ottieni una chiave API

Ogni endpoint di Sofia API v1 con parametri, scope ed esempi, e un playground per provarli uno a uno con la tua chiave API.

URL di base https://api.sofia-post.com/api · Documento OpenAPI

OAuth

GET/v1/oauth/authorizeAvviare un'autorizzazioneAprila nel browser. Un client sconosciuto o una redirect_uri non registrata dà un 400; altrimenti reindirizza alla schermata di consenso di Sofia.GET/.well-known/oauth-authorization-server/api/v1/oauthLeggere i metadati del serverRestituisce i metadati del server di autorizzazione OAuth 2.0 di Sofia API (RFC 8414), così un client scopre gli endpoint e le opzioni supportate.POST/v1/oauth/tokenEmettere un token di accessoScambia client_credentials, un authorization_code con PKCE o un refresh_token monouso con un token opaco di 3600 s per un Workspace.

Account

GET/v1/meChi sonoDescrive il token chiamante: tipo, applicazione, persona per cui agisce, Workspace, permessi, modalità e scadenza. Qualsiasi token valido può leggerlo.

Piattaforme

GET/v1/platformsElencare le piattaformeElenca ogni rete con nome e regole su media e formati, le stesse di sandbox e simulazione, e se è aperta al titolare del token.

Attività

GET/v1/establishmentsElencare le attivitàElenca le attività del Workspace del token. Usa i loro identificatori come establishmentId per pubblicare, elencare i media o leggere le statistiche.GET/v1/establishments/{id}/accountsElencare gli account collegatiElenca le reti collegate a un'attività, senza token né secret di rete, solo ciò che serve per nominare un account e sceglierlo come accountId.POST/v1/establishments/{id}/connection-linksCreare un link di collegamentoRestituisce un link ospitato dove la persona autorizza una rete con Sofia, senza che alcun token di rete arrivi alla tua app. Valido 30 minuti; solo app live.GET/v1/establishments/{id}/insightsLeggere le statisticheRestituisce gli ultimi dati validi raccolti da Sofia per ogni account collegato. Un account non ancora raccolto mostra awaiting, mai zero.

Media

GET/v1/mediaElencare i mediaElenca la mediateca di un'attività, i più recenti prima, pagina per pagina, con URL firmati per la finestra corrente. Funziona in test e in live.POST/v1/mediaImportare o caricare un mediaAggiunge alla mediateca di un'attività un file (multipart) o un URL https che Sofia scarica. Richiede un'app live e un abbonamento attivo.GET/v1/media/{id}Leggere un mediaRestituisce un media della mediateca con un URL firmato valido per la finestra corrente, così puoi riutilizzarne l'identificatore in una pubblicazione.DELETE/v1/media/{id}Rimuovere un mediaRimuove un media dalla mediateca della sua attività, come fa l'app. Il file non viene distrutto e una pubblicazione programmata mantiene il suo visual.

Pubblicazioni

GET/v1/postsElencare le pubblicazioniElenca le pubblicazioni delle attività raggiungibili dal token, le più recenti prima, filtrabili per attività, stato, date e autore, pagina per pagina.POST/v1/postsPubblicare una pubblicazioneLe app live pubblicano subito, programmano o salvano una bozza; quelle di test simulano soltanto. Con ?dry_run=true controlla tutto e non scrive nulla.GET/v1/posts/{id}Leggere una pubblicazioneRestituisce una pubblicazione con lo stato di ogni rete, il link una volta pubblicata e l'errore. Live: ogni pubblicazione del Workspace; test: una simulata.PATCH/v1/posts/{id}Modificare una pubblicazioneFinché nessuna rete ha iniziato l'invio, sostituisce targets, imposta scheduledAt o passa tra draft e scheduled. I campi omessi restano invariati.DELETE/v1/posts/{id}Eliminare una pubblicazioneElimina una pubblicazione come fa l'app: nulla di programmato viene inviato e una già pubblicata è rimossa dalla sua rete. In test non c'è nulla da eliminare.

Webhook

GET/v1/webhooksElencare i webhookElenca i webhook dell'applicazione senza il loro secret di firma, che viene restituito solo quando il webhook è registrato.POST/v1/webhooksRegistrare un webhookRegistra un URL https che Sofia chiama con un evento JSON firmato, ritentato fino a cinque volte se fallisce. Secret mostrato una volta; massimo 10 webhook.DELETE/v1/webhooks/{id}Eliminare un webhookElimina un webhook. Non riceve più nulla, nemmeno le consegne che attendevano un nuovo tentativo, e la chiamata non restituisce alcun body.POST/v1/webhooks/{id}/testInviare un evento di testConsegna un evento webhook.test firmato come gli altri, senza attendere il ricevente, così puoi verificare la tua firma. Al massimo cinque al minuto.