# 패키지 스냅샷 갱신

`POST /account/api/v1/residential/packages/refresh`

## 권한 인증

`Authorization: Bearer YOUR_ARNPROXY_API_KEY`

`Accept: application/json`

필요한 권한: `residential_management`

`Content-Type: application/json`

## 매개변수

| 이름 | 유형 | 필수 / 조건부 | 기본값 | 설명 |
|---|---|---|---|---|
| `package_id` (body) | integer | 필수 | — | residential_packages의 ARNPROXY 패키지 ID이며 공급자의 package_key가 아닙니다. |

## 요청 본문

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

```json
{
  "package_id": "YOUR_PACKAGE_ID"
}
```

## 요청 예제

### curl

```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/residential/packages/refresh'
```

### python

```python
import os, requests

headers = {"Authorization": "Bearer " + os.environ["ARNPROXY_API_KEY"]}
import json
with open("request.json", encoding="utf-8") as f:
    payload = json.load(f)
response = requests.post(
    "https://www.arnproxy.com/account/api/v1/residential/packages/refresh",
    headers=headers, json=payload,
    timeout=(10, 30), allow_redirects=False
)
print(response.status_code, response.text)
# No automatic write retry.
```

### javascript

```javascript
const headers = { Authorization: `Bearer ${process.env.ARNPROXY_API_KEY}` };
const { readFile } = await import('node:fs/promises');
headers['Content-Type'] = 'application/json';
const body = await readFile('request.json', 'utf8');
const response = await fetch("https://www.arnproxy.com/account/api/v1/residential/packages/refresh", {
  method: 'POST', headers, redirect: 'error',
  signal: AbortSignal.timeout(30000), body
});
console.log(response.status, await response.text());
// A write timeout is ambiguous; query its saved operation.
```

### php

```php
<?php
$headers = ['Accept: application/json',
    'Authorization: Bearer '.getenv('ARNPROXY_API_KEY')];
$headers[] = 'Content-Type: application/json';
$ch = curl_init('https://www.arnproxy.com/account/api/v1/residential/packages/refresh');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => $headers,
    CURLOPT_FOLLOWLOCATION => false,
    CURLOPT_SSL_VERIFYPEER => true, CURLOPT_SSL_VERIFYHOST => 2,
    CURLOPT_CONNECTTIMEOUT => 10, CURLOPT_TIMEOUT => 30,
    CURLOPT_POST => true,
    CURLOPT_POSTFIELDS => file_get_contents('request.json'),
]);
$result = curl_exec($ch);
if ($result === false) {
    // Do not repeat a write; use the original operation key.
    throw new RuntimeException('Transport result unknown');
}
echo curl_getinfo($ch, CURLINFO_HTTP_CODE).PHP_EOL.$result;
curl_close($ch);
```

### go

```go
package main

import (
  "fmt"
  "io"
  "net/http"
  "os"
  "time"
)

func main() {
  client := &http.Client{Timeout: 30*time.Second,
    CheckRedirect: func(req *http.Request, via []*http.Request) error {
      return http.ErrUseLastResponse
    }}
  var body io.Reader
  file, err := os.Open("request.json"); if err != nil { panic(err) }
  defer file.Close(); body = file
  req, err := http.NewRequest("POST", "https://www.arnproxy.com/account/api/v1/residential/packages/refresh", body)
  if err != nil { panic(err) }
  req.Header.Set("Authorization", "Bearer "+os.Getenv("ARNPROXY_API_KEY"))
  req.Header.Set("Content-Type", "application/json")
  res, err := client.Do(req); if err != nil { panic(err) }
  defer res.Body.Close()
  data, err := io.ReadAll(res.Body); if err != nil { panic(err) }
  fmt.Println(res.StatusCode, string(data))
}
```

### csharp

```csharp
using System;
using System.IO;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;

using var handler = new HttpClientHandler { AllowAutoRedirect = false };
using var client = new HttpClient(handler) { Timeout = TimeSpan.FromSeconds(30) };
using var request = new HttpRequestMessage(HttpMethod.Post,
    "https://www.arnproxy.com/account/api/v1/residential/packages/refresh");
request.Headers.Authorization = new AuthenticationHeaderValue(
    "Bearer", Environment.GetEnvironmentVariable("ARNPROXY_API_KEY"));
request.Content = new StringContent(
    await File.ReadAllTextAsync("request.json"), Encoding.UTF8, "application/json");
using var response = await client.SendAsync(request);
Console.WriteLine((int)response.StatusCode);
Console.WriteLine(await response.Content.ReadAsStringAsync());
// Never automatically retry an ambiguous write.
```

### java

```java
import java.net.URI;
import java.net.http.*;
import java.nio.charset.StandardCharsets;
import java.nio.file.*;

// Inside your application method:
var client = HttpClient.newHttpClient();
var request = HttpRequest.newBuilder(URI.create("https://www.arnproxy.com/account/api/v1/residential/packages/refresh"))
    .header("Authorization", "Bearer " + System.getenv("ARNPROXY_API_KEY"))
    .header("Accept", "application/json")
    .header("Content-Type", "application/json")
    .POST(HttpRequest.BodyPublishers.ofString(
        Files.readString(Path.of("request.json"), StandardCharsets.UTF_8)))
    .build();
var response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.statusCode());
```

## 응답 · HTTP 200

```json
{
  "ok": true,
  "data": {
    "state": "refreshed",
    "package": {
      "id": 20001,
      "state": "active",
      "snapshot": {
        "source": "arnproxy_records",
        "observed_at": "2030-01-01T12:00:00+00:00",
        "fresh": true,
        "max_age_seconds": 3600,
        "reason": null
      },
      "traffic": {
        "limit_bytes": "10737418240",
        "used_bytes": "1073741824",
        "remaining_bytes": "9663676416"
      },
      "expires_at": "2030-02-01T20:59:59+00:00",
      "rotation_seconds": 0,
      "management_available": false,
      "topup_available": true
    },
    "source": "provider_verified_snapshot",
    "provider_get_requests": 1,
    "provider_write_requests": 0,
    "snapshot_rows_updated": 1,
    "balance_changes": 0,
    "purchases": 0,
    "customer_proxy_expiry_changes": 0
  },
  "meta": {
    "request_id": "000000000000000000000001",
    "phase": "public_v1",
    "source": "provider_verified_snapshot"
  }
}
```

| 이름 | 유형 | 조건부 | 설명 |
|---|---|---|---|
| `ok` | boolean | — | 성공 여부. false이면 error.code를 확인하세요. |
| `data` | object | — | 작업별 결과이며 예제는 설명용 합성 데이터입니다. |
| `data.state` | string | — | 기록/작업 상태. accepted는 배송 완료가 아니며 completed는 연결 테스트가 아닙니다. |
| `data.package` | object | — | package의 작업별 값입니다. 반환된 유형을 유지하고 동작 설명을 확인하세요. |
| `data.package.id` | integer | — | 관련 ARNPROXY 기록 ID. 공급자 내부 ID 대신 사용하세요. |
| `data.package.state` | string | — | 기록/작업 상태. accepted는 배송 완료가 아니며 completed는 연결 테스트가 아닙니다. |
| `data.package.snapshot` | object | — | 패키지 관측의 출처/시간/최신성. 오래된 스냅샷은 관리 권한을 주지 않습니다. |
| `data.package.snapshot.source` | string | — | 데이터 출처. 로컬 기록과 실시간 공급자 조회는 서로 다른 근거입니다. |
| `data.package.snapshot.observed_at` | string | — | API가 반환하는 형식의 타임스탬프. 예제 날짜는 합성값입니다. |
| `data.package.snapshot.fresh` | boolean | — | 관측이 최신성 허용 범위에 들어가는지 여부. |
| `data.package.snapshot.max_age_seconds` | integer | — | 최신 관측으로 인정하는 최대 경과 초. |
| `data.package.snapshot.reason` | string|null | — | 고정 사유 코드 또는 null이며 원본 공급자 오류 텍스트가 아닙니다. |
| `data.package.traffic` | object | — | traffic의 작업별 값입니다. 반환된 유형을 유지하고 동작 설명을 확인하세요. |
| `data.package.traffic.limit_bytes` | string | — | 10진수 문자열 바이트 수. JavaScript Number 변환 시 정밀도 손실에 주의하세요. |
| `data.package.traffic.used_bytes` | string | — | 10진수 문자열 바이트 수. JavaScript Number 변환 시 정밀도 손실에 주의하세요. |
| `data.package.traffic.remaining_bytes` | string | — | 10진수 문자열 바이트 수. JavaScript Number 변환 시 정밀도 손실에 주의하세요. |
| `data.package.expires_at` | string | — | expires at의 작업별 값입니다. 반환된 유형을 유지하고 동작 설명을 확인하세요. |
| `data.package.rotation_seconds` | integer | — | 기록/요청된 회전 초. Rotating 패키지와 Residential 목록의 규칙은 다릅니다. |
| `data.package.management_available` | boolean | — | 조건/권한에 따른 사용 가능 여부이며 재고나 공급자 보장은 아닙니다. |
| `data.package.topup_available` | boolean | — | topup available의 작업별 값입니다. 반환된 유형을 유지하고 동작 설명을 확인하세요. |
| `data.source` | string | — | 데이터 출처. 로컬 기록과 실시간 공급자 조회는 서로 다른 근거입니다. |
| `data.provider_get_requests` | integer | — | provider get requests의 작업별 값입니다. 반환된 유형을 유지하고 동작 설명을 확인하세요. |
| `data.provider_write_requests` | integer | — | provider write requests의 작업별 값입니다. 반환된 유형을 유지하고 동작 설명을 확인하세요. |
| `data.snapshot_rows_updated` | integer | — | snapshot rows updated의 작업별 값입니다. 반환된 유형을 유지하고 동작 설명을 확인하세요. |
| `data.balance_changes` | integer | — | 보고된 작업 효과. 자동 갱신 설정은 향후 별도의 결제를 유발할 수 있습니다. |
| `data.purchases` | integer | — | purchases의 작업별 값입니다. 반환된 유형을 유지하고 동작 설명을 확인하세요. |
| `data.customer_proxy_expiry_changes` | integer | — | customer proxy expiry changes의 작업별 값입니다. 반환된 유형을 유지하고 동작 설명을 확인하세요. |
| `meta` | object | — | 요청 추적 및 데이터 출처 메타데이터. |
| `meta.request_id` | string | — | 이 HTTP 요청의 추적 ID이며 작업 키나 주문 ID가 아닙니다. |
| `meta.phase` | string | — | phase의 작업별 값입니다. 반환된 유형을 유지하고 동작 설명을 확인하세요. |
| `meta.source` | string | — | 데이터 출처. 로컬 기록과 실시간 공급자 조회는 서로 다른 근거입니다. |

## 동작 및 주요 참고 사항

- 패키지와 목록 ID는 ARNPROXY 기록 ID이며 공급자 키가 아닙니다. 오래된 스냅샷은 접근을 허용하지 않습니다. 필요 시 residential_package_refresh를 사용하세요.

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

[오류 및 제한](https://docs.arnproxy.com/ko/api-v1/errors)
