ARNPROXY

Kendi proxynin notunu kaydet; boş metinle temizle

POST/account/api/v1/proxies/note

Yetkilendirme

AuthorizationBearer YOUR_ARNPROXY_API_KEY
Gerekli izinproxy_management
Acceptapplication/json
Content-Typeapplication/json

Parametreler

AdTürAçıklama
proxy_id
bodyZorunlu
integerKendi aktif proxynizin ID’si; 1–2147483647.
note
bodyZorunlu
stringKırpılmış not: en fazla 500 karakter ve okuma yanıtındaki depolama sınırı. Boş metin temizler.
expected_revision
bodyZorunlu
stringBu işlemin kapsam/ayar okumasındaki revision; 64 küçük harfli onaltılık karakter.

İstek gövdesi

YOUR_/FROM_ alanlarını ilgili katalog, fiyat veya kapsam değerleriyle değiştirin. Örneklerde onay false bırakılır; gerçek işlemi yalnız bilinçli olarak onaylayın.

request.json
{
    "proxy_id": "YOUR_PROXY_ID",
    "note": "My application",
    "expected_revision": "FROM_PROXY_NOTE_REVISION"
}

İstek örneği

cURL
printf 'Authorization: Bearer %s\n' "$ARNPROXY_API_KEY" |
  curl --silent --show-error --header @- \
    --header 'Accept: application/json' \
    --connect-timeout 10 --max-time 30 \
    --request POST --header 'Content-Type: application/json' \
    --data-binary @request.json \
    'https://www.arnproxy.com/account/api/v1/proxies/note'

Örnekler bu sayfada çalıştırılmaz. API anahtarını sunucu ortam değişkeninde tutun; gerçek anahtarı URL veya tarayıcı koduna yazmayın. POST örnekleri için request.json hazırlayın.

Yanıtlar

200Başarılı yanıt
application/json
{
    "ok": true,
    "data": {
        "state": "completed",
        "changed": true,
        "provider_requests": 0,
        "proxy_id": 12345,
        "note": "Example label",
        "revision": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
        "note_update_available": true,
        "clear_with_empty_string": true,
        "source": "arnproxy_records",
        "maximum_length": 500,
        "maximum_utf8_bytes": 2000,
        "full_unicode_supported": true
    },
    "meta": {
        "request_id": "000000000000000000000001",
        "phase": "public_v1",
        "source": "arnproxy_records"
    }
}
Yanıt alanları ve türleri
AdTürAçıklama
okbooleanBaşarılı istek zarfı; false ise error.code alanını okuyun.
dataobjectİşleme özel sonuç. Örnekler temsili ve sentetiktir.
data.statestringBu kaydın/işlemin durumu. accepted teslimat, completed bağlantı testi anlamına gelmez.
data.changedbooleanNot gerçekten değişti mi? Aynı metin zaten varsa false dönebilir.
data.provider_requestsintegerprovider requests alanının işleme özel değeri; örnekteki türü ve ilgili davranış notlarını esas alın.
data.proxy_idintegerİlgili ARNPROXY kayıt kimliği. Sağlayıcının iç kimliği yerine bunu kullanın.
data.notestringnote alanının işleme özel değeri; örnekteki türü ve ilgili davranış notlarını esas alın.
data.revisionstringİlgili değişiklik/fiyat onayında aynen geri gönderilecek güncellik özeti.
data.note_update_availablebooleannote update available alanının işleme özel değeri; örnekteki türü ve ilgili davranış notlarını esas alın.
data.clear_with_empty_stringbooleanclear with empty string alanının işleme özel değeri; örnekteki türü ve ilgili davranış notlarını esas alın.
data.sourcestringBu alanın veri kaynağı; yerel kayıt ile canlı sağlayıcı okuması aynı şey değildir.
data.maximum_lengthintegermaximum length alanının işleme özel değeri; örnekteki türü ve ilgili davranış notlarını esas alın.
data.maximum_utf8_bytesintegermaximum utf8 bytes alanının işleme özel değeri; örnekteki türü ve ilgili davranış notlarını esas alın.
data.full_unicode_supportedbooleanfull unicode supported alanının işleme özel değeri; örnekteki türü ve ilgili davranış notlarını esas alın.
metaobjectİstek izleme ve veri kaynağı bilgileri.
meta.request_idstringBu HTTP isteğinin kimliği; işlem anahtarı veya sipariş ID’si değildir.
meta.phasestringphase alanının işleme özel değeri; örnekteki türü ve ilgili davranış notlarını esas alın.
meta.sourcestringBu alanın veri kaynağı; yerel kayıt ile canlı sağlayıcı okuması aynı şey değildir.

Hata yanıtı

HTTP 401 · INVALID_API_KEY
{
  "ok": false,
  "error": { "code": "INVALID_API_KEY" },
  "meta": { "request_id": "000000000000000000000001" }
}

Kimlik doğrulama ve alan denetimleri işlemi başlamadan reddedebilir. Hata rehberini inceleyin; destek için request_id saklayın. Anahtar veya şifre göndermeyin. Hatalar ve limitler →

Davranış ve önemli notlar

  • Müşteri panelindeki mevcut Proxy Notu alanı kullanılır; sağlayıcıya iletilmez. En fazla 500 karakter ve GET yanıtındaki depolama sınırı uygulanır. note="" temizler. Önce proxy_note ile revision alın. Aynı değer zaten varsa changed:false; farklı değer için eski revision ile üzerine yazılmaz. Idempotency-Key gerekmez; yanıt belirsizse önce notu yeniden okuyun.

Geçerli dilde arar. Kapatmak için Esc