Referensi API

Dapatkan kunci API

Setiap endpoint Sofia API v1 dengan parameter, scope, dan contohnya, serta playground untuk mencoba masing-masing dengan kunci API Anda sendiri.

URL dasar https://api.sofia-post.com/api · Dokumen OpenAPI

OAuth

GET/v1/oauth/authorizeMulai otorisasiBuka di browser pengguna. Klien tidak dikenal atau redirect_uri belum terdaftar menghasilkan 400; selain itu diarahkan ke layar persetujuan Sofia.GET/.well-known/oauth-authorization-server/api/v1/oauthAmbil metadata serverMengembalikan metadata server otorisasi OAuth 2.0 dari Sofia API (RFC 8414), agar klien dapat menemukan endpoint dan opsi yang didukung.POST/v1/oauth/tokenTerbitkan access tokenMenukar client_credentials, authorization_code dengan PKCE, atau refresh_token sekali pakai dengan token buram berlaku 3600 detik untuk satu Workspace.

Akun

GET/v1/meSiapa sayaMenjelaskan token yang memanggil: jenisnya, aplikasi, orang yang diwakilinya, Workspace, scope, mode, dan masa berlakunya. Token valid apa pun dapat membacanya.

Platform

GET/v1/platformsDaftar platformMendaftar setiap jaringan beserta aturan caption, media, dan format, sama dengan yang diterapkan sandbox dan dry run, serta apakah terbuka bagi pemilik token.

Usaha

GET/v1/establishmentsDaftar usahaMendaftar usaha di Workspace tempat token bertindak. Pakai pengenalnya sebagai establishmentId saat memublikasikan, mendaftar media, atau membaca insight.GET/v1/establishments/{id}/accountsDaftar akun yang terhubungMendaftar jaringan yang terhubung ke sebuah usaha, tanpa token atau secret jaringan, hanya yang perlu untuk menamai akun dan memilihnya sebagai accountId.POST/v1/establishments/{id}/connection-linksBuat tautan koneksiMengembalikan tautan terhosting tempat orang mengotorisasi jaringan di Sofia, sehingga token jaringan tak sampai ke aplikasi Anda. Berlaku 30 menit.GET/v1/establishments/{id}/insightsAmbil insight usahaMengembalikan angka valid terbaru yang dikumpulkan Sofia untuk setiap akun yang terhubung. Akun yang belum dikumpulkan terbaca awaiting, tidak pernah nol.

Media

GET/v1/mediaDaftar mediaMendaftar pustaka media sebuah usaha, terbaru lebih dulu, per halaman, dengan URL bertanda tangan untuk jendela saat ini. Berfungsi di mode uji dan live.POST/v1/mediaImpor atau unggah mediaMenambahkan file (multipart) atau URL https yang diambil Sofia ke pustaka media sebuah usaha. Perlu aplikasi live dan langganan aktif.GET/v1/media/{id}Ambil mediaMengembalikan satu media dari pustaka dengan URL bertanda tangan yang berlaku untuk jendela saat ini, agar pengenalnya bisa dipakai ulang di postingan.DELETE/v1/media/{id}Hapus mediaMenghapus media dari pustaka usahanya, seperti yang dilakukan aplikasi. File tidak dimusnahkan dan postingan terjadwal tetap memakai visualnya.

Postingan

GET/v1/postsDaftar postinganMendaftar postingan usaha yang dijangkau token, terbaru lebih dulu, dapat difilter menurut usaha, status, rentang tanggal, dan penulis, per halaman.POST/v1/postsPublikasikan postinganAplikasi live memublikasikan langsung, menjadwalkan, atau menyimpan draf; aplikasi uji hanya mensimulasikan. Dengan ?dry_run=true semua dicek tanpa menulis.GET/v1/posts/{id}Ambil postinganMengembalikan postingan dengan status tiap jaringan, tautan, dan kesalahan bila gagal. Live membaca postingan apa pun di Workspace, uji yang disimulasikan.PATCH/v1/posts/{id}Ubah postinganSebelum jaringan mengirim, mengganti targets, mengatur scheduledAt, atau memindahkan postingan antara draft dan scheduled. Kolom yang dihilangkan tetap.DELETE/v1/posts/{id}Hapus postinganMenghapus postingan seperti di aplikasi: yang terjadwal tidak dikirim, yang terbit dihapus dari jaringannya. Aplikasi uji tak punya yang nyata untuk dihapus.

Webhook

GET/v1/webhooksDaftar webhookMendaftar webhook aplikasi tanpa signing secret-nya, yang hanya dikembalikan satu kali saat webhook didaftarkan, sehingga tidak bisa diambil lagi.POST/v1/webhooksDaftarkan webhookMendaftarkan URL https yang dipanggil Sofia dengan event JSON bertanda tangan, diulang hingga lima kali bila gagal. Secret tampil sekali; maksimal 10 webhook.DELETE/v1/webhooks/{id}Hapus webhookMenghapus webhook. Webhook itu tidak menerima apa pun lagi, termasuk pengiriman yang masih menunggu percobaan ulang, dan panggilan ini tidak mengembalikan body.POST/v1/webhooks/{id}/testKirim event ujiMengirim event webhook.test bertanda tangan seperti event lain, tanpa menunggu penerima, agar Anda bisa memeriksa tanda tangan. Maksimal lima per menit.