Ana içeriğe atla
POST

Ne yapar?

status boolean olarak açıkça gönderilmelidir. İlk kayıtta title ve geçerli domain gerekir; status=false ilk kurulum desteklenir. Güncellemede domain atlanırsa mevcut adres korunur; kapatma domain silmez. Yalnız belgelenmiş alanlar kabul edilir; modules en fazla 100 kısa metindir. Domain çakışması 409.

Ön koşullar ve izin

Etkin API anahtarı ve muhasip:oim:write izni gerekir. İlişkili kayıtlar aynı firmaya ait olmalıdır. Erişim ayarları için kimlik ve izinler rehberini inceleyin. İstek ve cevap şemalarını indirin.

İstek örnekleri

Örnekler temsilîdir. Kimlikleri, belge tarihlerini ve iş verisini kendi yetkili kayıtlarınızla değiştirin. Node.js örnekleri Node.js 20 veya üzeri içindir; PHP örnekleri cURL uzantısını kullanır. Hiçbiri otomatik tekrar yapmaz.

Cevabı değerlendirin

Önce HTTP durumunu, ardından bu kaynağın status ve sonuç alanlarını değerlendirin. Bütün uçlar aynı sonuç zarfını veya oluşturma için 201 kodunu kullanmaz. Temsilî başarılı cevap; gerçek hizmet çağrısından alınmamıştır:

Hata durumunda

Ağ kesintisi, zaman aşımı veya JSON olmayan cevap mali etkinin oluşmadığını kanıtlamaz. Ham istek/cevapları genel loglara yazmayın. Hata yönetimi

Sonraki adım

İlgili liste veya detay çağrısıyla kaydı ve bağlı iş sonucunu doğrulayın. Fiziksel silme, arşiv ve mali iptali ayrı değerlendirin. Kaynak akışı · İşlem takibi · Kapsam ve sınırlamalar

Yetkilendirmeler

Authorization
string
header
gerekli

Kullanıcı adı apiUserId, parola secretKey. Aktif ve süresi geçmemiş API kullanıcısı ve uygun firma gerekir.

Gövde

application/json
status
boolean
gerekli

Online işlemleri etkinleştirir.

title
string

Online işlem ekranı başlığı; yeni kayıtta gereklidir.

Maximum string length: 1000
description
string
Maximum string length: 5000
domain
string

İlk kayıtta gereklidir; güncellemede atlanırsa mevcut adres korunur. Ayrılmış/uygunsuz değer kabul edilmez.

Required string length: 4 - 63
Pattern: ^[a-z0-9][a-z0-9-]{2,61}[a-z0-9]$
paymentStatus
boolean
varsayılan:false

Online ödeme görünürlüğü. Varsayılan yalnız yeni kayıttadır; güncellemede atlanırsa mevcut değer korunur.

publicPayment
boolean
varsayılan:false

Üyeliksiz ödeme görünürlüğü. Varsayılan yalnız yeni kayıttadır; güncellemede atlanırsa mevcut değer korunur.

Maximum string length: 1000
auth
string
varsayılan:vknCode

Giriş yöntemi yapılandırması; uç sabit enum doğrulamaz. Varsayılan yalnız yeni kayıttadır; güncellemede atlanırsa mevcut değer korunur.

Maximum string length: 1000
modules
string[]
Maximum array length: 100
Maximum string length: 100

Yanıt

İşlem tamamlandı.

status
enum<boolean>
gerekli
Mevcut seçenekler:
true
Örnek:

true