Geliştiriciler

POST/v3/update_document/{uuid}

Kayıt profilini güncelleme

Profilin düzenlenebilir bilgilerinin tamamını gönderin ve eski başarı yanıtı biçimini işleyin.

Bu sayfada
  1. Profilin düzenlenebilir bilgilerini değiştirme
  2. Güncelleme isteği
  3. Gelişmiş: önceden yüklenmiş kanıt belgeleri ekleme
  4. Eski biçimdeki başarı ve hata yanıtları
  5. Güncellemenin mevcut sınırları ve hata sonrası toparlanma

Profilin düzenlenebilir bilgilerini değiştirme

Hesabınıza ait mevcut bir kayıt profilini, yerel UUID değerini şu kaynaklardan alarak güncelleyin: create_document veya documents. Bu işlem hem hesap verilerini hem de bağlı operatördeki verileri değiştirir. Kayıtlı Personal/Business kimlik türünü değiştirmez ve yalnızca bazı alanları güncelleyen bir PATCH işlemi değildir.

Güncelleme isteği

İzin verilen bir IP adresinden etkin MultiTEL API hesabınızla kimlik doğrulaması yapın. Örneklerde ortam değişkenlerinde tutulan kimlik bilgileri ve kurgusal veriler kullanılır. HTTP yanıtının yanı sıra JSON içindeki status.code ve status.msg alanlarını da okuyun.

curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
  --header 'Content-Type: application/json' \
  --data @registration-profile-update.json \
  "https://api.multitel.net/v3/update_document/$DOCUMENT_UUID"
{
  "first_name": "Example",
  "last_name": "Person",
  "phone_number": "12025550123",
  "email": "end-user@example.com",
  "city": "Example City",
  "postal_code": "00000",
  "address": "1 Example Street",
  "country": "US",
  "nationality": "US",
  "signature": "BASE64_PNG_OF_THE_AUTHORIZED_END_USER_SIGNATURE",
  "id_number": "",
  "personal_tax_id": "",
  "birth_date": "",
  "description": "Example profile",
  "company_name": "",
  "company_reg_number": "",
  "incorporation_country": "",
  "vat_id": "",
  "address_description": ""
}

Örnekte Personal türünde bir profil gösterilmektedir; örnek bilgileri, son kullanıcının kullanılması amaçlanan eksiksiz bilgileri ve kullanımına izin verdiği imzasıyla değiştirin. Verileri korumak amacıyla yer tutucu imzalar veya boş değerler göndermeyin. JSON ve form kodlamalı girdi desteklenir.

Güncelleme alanlarının gereksinimleri
AlanlarDavranış
first_name, last_name, city, postal_code, addressZorunludur; her biri en fazla 64 karakter olabilir.
phone_numberEn az sekiz karakterden oluşan sayısal bir değer zorunludur; numarayı ülke kodu dahil uluslararası biçimde rakamlarla yazın.
signatureZorunludur. Portal, veri URL'si öneki olmadan Base64 kodlamalı PNG baytlarını sağlar.
countryKayıt kataloğundan adresin ülkesine ait bir ISO kodu sağlayın. İncelenen adres güncellemesi ülke ilişkisini değiştirmese de istek işleyicisi bu kodun karşılık geldiği ülkeyi belirler.
nationalityMevcut bir Personal profili için ülke ISO kodu zorunludur.
company_name, incorporation_countryMevcut bir Business profili için zorunludur; şirket adı en fazla 64 karakter olmalı ve kuruluş ülkesi bir ISO koduyla belirtilmelidir.
emailİsteğe bağlı, en fazla 254 karakterlik geçerli bir e-posta adresidir. Kayıtlı iletişim e-posta adresini korumak için bu alanı göndermeyin; yerel kayıttan silmek için boş bir değer gönderin.
id_number, personal_tax_id, birth_date, description, company_reg_number, vat_idKullanılmasını istediğiniz güncel değerleri gönderin. Gönderilmeyen değerler varsayılan olarak boş kabul edilir ve mevcut kayıtlı değerlerin üzerine yazabilir.

Ülkeye özgü kayıt kuralları ek bilgiler veya biçimler gerektirebilir. Eksiksiz bir güncelleme oluştururken yalnızca şu kaynağa dayanmayın: get_document; bu kaynağın sınırlı yanıtı ülke seçimi alanlarını, email alanını ve varlık kimliklerini içermez. Kullanma yetkiniz olan kaynak verilerinizi saklayın veya portalın belge düzenleyicisini kullanın.

Gelişmiş: önceden yüklenmiş kanıt belgeleri ekleme

İsteğe bağlı identity_encryptfiles ve address_encryptfiles dizileri, şu kaynaktan alınan etkin ve hesabınıza ait referansları kabul eder: create_encrypt_files. Varlık kategorisinin yüklemedeki kategoriyle eşleşmesini sağlayın ve referansın süresi dolmadan gönderin. Birden fazla dosya aynı kanıt türüne ait olsa bile her dosya ayrı bir kanıt isteğiyle eklenir. Birden fazla dosyadan oluşan bir kimlik kanıtı için sonraki kanıt belgesi ekleme iş akışını tek bir diziyle kullanın.

Yeni oluşturulan bir adres için sonraki bir adres kanıtı reddedilirse, onun yerine profil UUID'sini kullanmayın ve kimliği tekrar tekrar yeniden oluşturmayın. Durun ve profili portalda veya destek ekibiyle kontrol edin. Adres kanıtı geri okuma/arama yolu bir inceleme sınırlaması olmaya devam etmektedir.

Eski biçimdeki başarı ve hata yanıtları

{
  "status": {
    "code": "success",
    "msg": "Successfully Saved."
  },
  "response": ""
}

Bu uç noktanın normal başarı kodu şu dizedir: success; sayısal 200 değildir. Bağlı operatördeki veya yerel sistemdeki normal bir hata şu dizeyi kullanabilir: error. Sayısal 400 geçersiz alanları veya kanıt hatalarını, 404 eksik bir profili ya da yüklenen dosyaya ait geçersiz bir referansı, 500 ise boş bir gövdeyi veya belirlenemeyen bir ülkeyi kapsar. Mesajı ve varsa doğrulama kayıtlarını okuyun; yalnızca HTTP 200 yanıtını başarı olarak değerlendirmeyin.

Güncellemenin mevcut sınırları ve hata sonrası toparlanma

Başarı bildirilmesi, bağlı operatördeki her alanın değiştiğini garanti etmez. İncelenen kod, operatördeki adres güncellemesi başarısız olduktan sonra yerel profili kaydedebilir. Operatördeki kimlik güncellemesi email alanını içermez. Bu işlem yolu, adres ülkesinin değiştirilmesini ve adres açıklamasının eşitlenmesini sağlamaz. Bu değişikliklere ihtiyacınız varsa operatördeki kaydın güncellendiğini varsaymak yerine sonucu portalda inceleyin ve destek birimiyle iletişime geçin.

Güncelleme tek bir atomik işlem değildir: daha sonra bir hata oluşmadan önce kimlik değişiklikleri yapılmış ve kanıt belgeleri eklenmiş olabilir. Bir idempotans anahtarı sunulmaz. Belirsiz bir yanıttan sonra yeniden denemeden önce profili ve ekleri inceleyin; kanıt belgelerinin tekrar gönderilmesi yinelenen kayıtlar oluşturabilir. Bir profilin güncellenmesi, kanıt belgelerinin onaylandığı anlamına gelmez ve bir numarayı etkinleştirmez.