ARNPROXY

프록시 메모 저장

POST/account/api/v1/proxies/note

권한 인증

AuthorizationBearer YOUR_ARNPROXY_API_KEY
필요한 권한proxy_management
Acceptapplication/json
Content-Typeapplication/json

매개변수

이름유형설명
proxy_id
body필수
integer본인 활성 프록시 기록 ID, 1–2147483647.
note
body필수
string앞뒤 공백 제거 후 최대 500자이며 조회 응답의 저장 한도를 따릅니다. 빈 문자열로 지웁니다.
expected_revision
body필수
string해당 범위/설정 조회의 revision: 소문자 16진수 64자.

요청 본문

YOUR_/FROM_을 해당 카탈로그, 견적 또는 범위의 값으로 바꾸세요. 예제의 동의 값은 false입니다. 실제 작업에 동의할 때만 승인하세요.

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

요청 예제

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'

이 페이지에서는 예제를 실행하지 않습니다. API 키는 서버 환경 변수에 보관하고 URL이나 브라우저 코드에 넣지 마세요. POST 예제에는 request.json을 준비하세요.

응답

200성공 응답
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"
    }
}
응답 필드 및 유형
이름유형설명
okboolean성공 여부. false이면 error.code를 확인하세요.
dataobject작업별 결과이며 예제는 설명용 합성 데이터입니다.
data.statestring기록/작업 상태. accepted는 배송 완료가 아니며 completed는 연결 테스트가 아닙니다.
data.changedboolean메모가 실제 변경되었는지 여부. 같은 내용이 이미 있으면 false일 수 있습니다.
data.provider_requestsintegerprovider requests의 작업별 값입니다. 반환된 유형을 유지하고 동작 설명을 확인하세요.
data.proxy_idinteger관련 ARNPROXY 기록 ID. 공급자 내부 ID 대신 사용하세요.
data.notestringnote의 작업별 값입니다. 반환된 유형을 유지하고 동작 설명을 확인하세요.
data.revisionstring해당 변경/가격 확인에 그대로 반환할 최신성 식별자입니다.
data.note_update_availablebooleannote update available의 작업별 값입니다. 반환된 유형을 유지하고 동작 설명을 확인하세요.
data.clear_with_empty_stringbooleanclear with empty string의 작업별 값입니다. 반환된 유형을 유지하고 동작 설명을 확인하세요.
data.sourcestring데이터 출처. 로컬 기록과 실시간 공급자 조회는 서로 다른 근거입니다.
data.maximum_lengthintegermaximum length의 작업별 값입니다. 반환된 유형을 유지하고 동작 설명을 확인하세요.
data.maximum_utf8_bytesintegermaximum utf8 bytes의 작업별 값입니다. 반환된 유형을 유지하고 동작 설명을 확인하세요.
data.full_unicode_supportedbooleanfull unicode supported의 작업별 값입니다. 반환된 유형을 유지하고 동작 설명을 확인하세요.
metaobject요청 추적 및 데이터 출처 메타데이터.
meta.request_idstring이 HTTP 요청의 추적 ID이며 작업 키나 주문 ID가 아닙니다.
meta.phasestringphase의 작업별 값입니다. 반환된 유형을 유지하고 동작 설명을 확인하세요.
meta.sourcestring데이터 출처. 로컬 기록과 실시간 공급자 조회는 서로 다른 근거입니다.

오류 응답

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

인증 및 검증 단계에서 실행 전에 요청이 거부될 수 있습니다. 오류 문서를 확인하고 지원 문의용 request_id를 보관하세요. 키나 비밀번호를 보내지 마세요. 오류 및 제한 →

동작 및 주요 참고 사항

  • 고객 패널의 기존 프록시 메모를 사용하며 공급자에게 보내지 않습니다. GET 저장 한도 내 최대 500자입니다. note=""로 지우고 proxy_note에서 revision을 먼저 읽으세요. 같은 값은 changed:false이며 오래된 revision은 다른 내용을 덮어쓰지 못합니다. Idempotency-Key는 불필요하며 결과가 불확실하면 다시 읽으세요.

현재 언어로 검색합니다. 닫기: Esc