Destekleyici belge ekleme

Şablona dayalı destekleyici belge ekleme

Şablon almak için şu işlemi kullanın: get_supporting_document_templates. Ayrıca, zaten hesabınıza ait olan bir kimlik kullanın. Belgenin dosyalarını yüklemek için şu işlemi kullanın: create_encrypt_files; kullanılacak alan: supporting_template_id. Standart kimlik veya adres kanıtı yüklemeleri farklı bir kategoriye aittir ve bunların yerine kullanılamaz.

Destekleyici belgeyi oluşturma

Etkin bir MultiTEL API hesabı ve bu hesap için izin verilen IP adresini kullanın. Örneklerde, ortam değişkenlerinden alınan HTTP Basic kimlik doğrulama bilgileri kullanılır; hesap türünüze ilişkin kimlik doğrulama kurallarına uyun. İstekleri HTTPS üzerinden gönderin. Hem HTTP yanıtını hem de JSON içindeki şu alanı kontrol edin: status.code; uygulama hataları HTTP 200 yanıtıyla da gelebilir. Aşağıdaki örnekler kurgusaldır.

curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
  --header 'Content-Type: application/json' \
  --data @supporting-request.json \
  https://api.multitel.net/v3/create_supporting_document

{
  "identity_id": "33333333333333333333333333333333",
  "template_id": "55555555555555555555555555555555",
  "encrypted_file_ids": [
    "66666666666666666666666666666666"
  ]
}

İstek alanları
Alan	Anlamı
`identity_id`	Hesabınızla ilişkili kimliğin zorunlu tanımlayıcısıdır. Bu istek belgeyi bir kimliğe ekler; doğrudan bir adrese veya telefon numarasına eklemez.
`template_id`	Destekleyici belge şablonunun zorunlu tanımlayıcısıdır; destekleyici dosya yüklemesinde seçtiğiniz şablonun aynısını kullanın. Ekleme alanı template_id, yükleme alanı ise supporting_template_id olarak adlandırılır.
`encrypted_file_ids`	Dönen yükleme tanımlayıcılarını içeren, boş olmayan zorunlu JSON dizisidir. Her biri mevcut hesaba ait olmalı, geçerlilik süresi dolmamış olmalı ve supporting_documents kategorisinde bulunmalıdır.

Şu alanın tekrarlandığı form verileri de kabul edilir: encrypted_file_ids[]. Bu belge ekleme uç noktasına dosya baytlarını göndermeyin.

Oluşturulan destekleyici belge

{
  "status": {
    "code": 200,
    "msg": "Supporting document created successfully."
  },
  "response": {
    "id": "77777777777777777777777777777777",
    "template_id": "55555555555555555555555555555555",
    "identity_id": "33333333333333333333333333333333",
    "template_name": "Example supporting template"
  }
}

Bu, destekleyici belgenin oluşturulduğunu doğrular; düzenleyici kurum onayını veya numaranın etkinleştirildiğini doğrulamaz. Üst sistemdeki kaynakta kullanılan “kalıcı” ifadesi, saklama süresi veya silme politikası konusunda müşteriye verilen bir garanti değildir.

Hatalar ve yeniden denemeler

API kodu 500, eksik girdileri, telekom operatörü hatalarını veya geçersiz bir operatör yanıtını belirtir. Kod 404, hesapla ilişkili olmayan bir kimliği, geçersiz bir şablonu, eksik, süresi dolmuş veya yanlış kategorideki yüklemeleri ya da kullanılabilir dosya kümesinin boş olduğunu belirtir. Şu alanı kontrol edin: status.msg; tek başına HTTP 200 yeterli değildir.

Yükleme ve ekleme işlemlerini, dönen dosya referansının geçerlilik süresi içinde tamamlayın. Sonucu belirsiz bir yanıt aldıktan sonra, yeniden denemeden önce portalda kimliğin destekleyici belgelerini kontrol edin. Bu istek işleyicisi bir idempotans anahtarı sunmaz.