Програмери

POST/v3/create_supporting_document

Приложите пратећи документ

Повежите отпремљене пратеће датотеке засноване на шаблону са идентитетом.

На овој страници
  1. Приложите пратећи документ заснован на шаблону
  2. Креирајте пратећи документ
  3. Креирани пратећи документ
  4. Грешке и поновни покушаји

Приложите пратећи документ заснован на шаблону

Користите шаблон из get_supporting_document_templates и идентитет који већ припада вашем налогу. Отпремите датотеке тог документа преко create_encrypt_files користећи supporting_template_id. Уобичајене отпремљене датотеке за доказивање идентитета или адресе припадају другој категорији и не могу се користити као замена.

Креирајте пратећи документ

Користите активан налог за MultiTEL API и његову дозвољену IP адресу. Примери користе акредитиве за HTTP Basic аутентификацију из променљивих окружења; придржавајте се правила аутентификације за свој тип налога. Шаљите захтеве преко HTTPS. Проверите и HTTP одговор и поље у JSON објекту status.code; грешке апликације могу стићи уз HTTP 200. Примери у наставку су измишљени.

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"
  ]
}
Поља захтева
ПољеЗначење
identity_idОбавезан идентификатор идентитета повезаног са вашим налогом. Овај захтев прилаже документ идентитету, а не непосредно адреси или телефонском броју.
template_idОбавезан идентификатор шаблона пратећег документа; користите исти изабрани шаблон као при отпремању пратећих датотека. Поље за прилагање је template_id, док је поље за отпремање supporting_template_id.
encrypted_file_idsОбавезан непразан JSON низ враћених идентификатора отпремљених датотека. Свака датотека мора припадати тренутном налогу, рок важења јој не сме бити истекао и мора бити у категорији supporting_documents.

Прихватају се и подаци обрасца са поновљеним пољима encrypted_file_ids[]. Немојте слати бајтове датотека овој крајњој тачки за прилагање.

Креирани пратећи документ

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

Ово потврђује креирање пратећег документа, а не регулаторно одобрење или активацију броја. Израз „трајно“ у изворном ресурсу не представља гаранцију клијенту у погледу трајања чувања или правила брисања.

Грешке и поновни покушаји

Код API 500 означава недостајуће улазне податке, грешке оператера или неважећи одговор оператера. Код 404 означава идентитет који није повезан са налогом, неважећи шаблон, отпремљене датотеке које недостају, којима је истекао рок важења или које припадају погрешној категорији, или празан скуп употребљивих датотека. Проверите status.msg; сам HTTP 200 није довољан.

Отпремите и приложите датотеке у року важења враћене референце на датотеку. Након неодређеног одговора, проверите пратеће документе идентитета на порталу пре поновног покушаја. Овај обрађивач не ставља на располагање кључ идемпотентности.