ARNPROXY

Simpan catatan proxy

POST/account/api/v1/proxies/note

Otorisasi

AuthorizationBearer YOUR_ARNPROXY_API_KEY
Izin yang diperlukanproxy_management
Acceptapplication/json
Content-Typeapplication/json

Parameter

NamaTipeKeterangan
proxy_id
bodyWajib
integerID catatan proxy aktif milik sendiri; 1–2147483647.
note
bodyWajib
stringCatatan setelah trim: maksimal 500 karakter dan batas penyimpanan pada respons baca. Teks kosong menghapusnya.
expected_revision
bodyWajib
stringrevision dari pembacaan cakupan/pengaturan terkait: 64 karakter heksadesimal kecil.

Isi permintaan

Ganti YOUR_/FROM_ dengan nilai katalog, kutipan harga, atau cakupan terkait. Persetujuan pada contoh tetap false; setujui operasi nyata secara sengaja.

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

Contoh permintaan

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'

Contoh tidak dijalankan di halaman ini. Simpan kunci API dalam variabel lingkungan server, bukan URL atau kode browser. Siapkan request.json untuk contoh POST.

Respons

200Respons berhasil
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"
    }
}
Kolom dan tipe respons
NamaTipeKeterangan
okbooleanPenanda berhasil; jika false, periksa error.code.
dataobjectHasil khusus operasi; contoh bersifat ilustratif dan sintetis.
data.statestringStatus catatan/operasi. accepted bukan terkirim; completed bukan tes koneksi.
data.changedbooleanApakah catatan berubah; false dapat berarti teks yang diinginkan sudah ada.
data.provider_requestsintegerNilai khusus operasi untuk provider requests. Pertahankan tipe yang dikembalikan dan baca catatan perilaku.
data.proxy_idintegerID catatan ARNPROXY terkait; gunakan alih-alih ID internal penyedia.
data.notestringNilai khusus operasi untuk note. Pertahankan tipe yang dikembalikan dan baca catatan perilaku.
data.revisionstringSidik kesegaran untuk disalin tanpa perubahan ke perubahan/konfirmasi harga terkait.
data.note_update_availablebooleanNilai khusus operasi untuk note update available. Pertahankan tipe yang dikembalikan dan baca catatan perilaku.
data.clear_with_empty_stringbooleanNilai khusus operasi untuk clear with empty string. Pertahankan tipe yang dikembalikan dan baca catatan perilaku.
data.sourcestringSumber data; catatan lokal dan kueri penyedia langsung merupakan bukti berbeda.
data.maximum_lengthintegerNilai khusus operasi untuk maximum length. Pertahankan tipe yang dikembalikan dan baca catatan perilaku.
data.maximum_utf8_bytesintegerNilai khusus operasi untuk maximum utf8 bytes. Pertahankan tipe yang dikembalikan dan baca catatan perilaku.
data.full_unicode_supportedbooleanNilai khusus operasi untuk full unicode supported. Pertahankan tipe yang dikembalikan dan baca catatan perilaku.
metaobjectMetadata korelasi permintaan dan sumber data.
meta.request_idstringID korelasi permintaan HTTP ini, bukan kunci operasi atau ID pesanan.
meta.phasestringNilai khusus operasi untuk phase. Pertahankan tipe yang dikembalikan dan baca catatan perilaku.
meta.sourcestringSumber data; catatan lokal dan kueri penyedia langsung merupakan bukti berbeda.

Respons kesalahan

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

Autentikasi dan validasi dapat menolak permintaan sebelum dijalankan. Lihat referensi kesalahan dan simpan request_id untuk dukungan. Jangan kirim kunci atau kata sandi. Kesalahan & batas →

Perilaku & catatan penting

  • Memakai catatan proxy panel pelanggan yang ada, tidak dikirim ke penyedia. Maksimal 500 karakter sesuai batas GET. note="" menghapus. Baca revision dari proxy_note dahulu. Nilai sama memberi changed:false; revision lama tidak menimpa teks berbeda. Tanpa Idempotency-Key; baca ulang jika hasil belum pasti.

Cari dalam bahasa saat ini. Tutup dengan Esc