Proxy-seller

APIリファレンスの活用方法

Updated:

このセクションでは、インタラクションの例や、API におけるパラメータの使い方について解説します。

この例で使用されているデータはすべて仮のデータであり、あくまで説明のためのものです。API を利用する際は、必ずご自身の有効なデータを使用してください。

エンドポイント：

PATCHhttps://mobile.proxy-seller.com/api/v1/hosts/{hostId}/changeName

よく見てみましょう

PATCH - は、クエリに使用されたメソッドを示します

{hostId} - は、有効な値に置き換えるべき変数を示します。

パスパラメータ

名前

種類

説明

hostId*

文字列

ホストのID

ヘッダー

名前

値

コンテンツタイプ

application/json

承認*

<YOUR_API_TOKEN>

リクエスト本文

名前

種類

説明

名前*

文字列

新しいホスト名

必須のパラメータにはすべてアスタリスク（*）が付いています。

例

https://mobile.proxy-seller.com/api/v1/hosts/21vjv1224n45v7457mvcas/changeName

クエリには、さまざまなパラメータのセットやタイプが設定可能です。下図を参照してください。

いくつかのプログラミング言語での使用例を見てみましょう

curl -X PATCH \
  -H "Content-Type: application/json" \
  -H "Authorization: YOUR_API_KEY" \
  -d '{"name":"Host new name"}' \
  "https://mobile.proxy-seller.com/api/v1/hosts/ID_OF_SOME_HOST/changeName"

User
import fetch from 'node-fetch';

const apiKey = "YOUR_API_KEY";
const hostId = "ID_OF_SOME_HOST";

// add path parameter to request
const url = "https://mobile.proxy-seller.com/api/v1/hosts/" + hostId + "/changeName";
// also "query" parameters are added here 
// const urlWithQuery = url + "?someNameParameter=someValue"
const body = { 
 name: "Host new name",
 // write here your body params
};
const response = await fetch(url, {
  method: 'patch',
  // add headers parameters to request
  headers: {
    'Content-Type': 'application/json', // it is impotent to body parameters
    'Authorization': apiKey,
    // write here your other headers params
  },
  // add body parameters to request
  body: JSON.stringify(body)
});

console.log(await response.json()); 
try {
            String apiKey = "YOUR_API_KEY";
            String hostId = "ID_OF_SOME_HOST";
            String url = "https://mobile.proxy-seller.com/api/v1/hosts/" + hostId + "/changeName";
            // also "query" parameters are added here 
            // String urlWithQuery = url + "?someNameParameter=someValue"
            // Constructing the request body
            String body = "{\"name\": \"Host new name"}";

            // Creating URL object
            URL obj = new URL(url);

            // Creating HTTPURLConnection
            HttpURLConnection con = (HttpURLConnection) obj.openConnection();

            // Setting the request method
            con.setRequestMethod("PATCH");

            // Setting headers
            con.setRequestProperty("Content-Type", "application/json");
            con.setRequestProperty("Authorization", apiKey);

            // Enabling the connection to send and receive data
            con.setDoOutput(true);

            // Writing the request body
            DataOutputStream wr = new DataOutputStream(con.getOutputStream());
            wr.writeBytes(body);
            wr.flush();
            wr.close();

            // Reading the response
            int responseCode = con.getResponseCode();
            BufferedReader in = new BufferedReader(new InputStreamReader(con.getInputStream()));
            String inputLine;
            StringBuffer response = new StringBuffer();
            while ((inputLine = in.readLine()) != null) {
                response.append(inputLine);
            }
            in.close();

            // Printing the response
            System.out.println(response.toString());
        } catch (Exception e) {
            e.printStackTrace();
        }

HTTPステータスコードごとの応答例。「200」は成功を、「4XX」コードはエラーを示します。

回答

{
    "id": "21vjv1224n45v7457mvcas",
    "name": "Host new name",
    "number": "101"
}
AUTHORIZATION_FAILED,
IP_AUTHORIZATION_FAILED,
HOST_USER_ID_AND_AUTH_DOES_NOT_MATCH
INVALID_HOST_ID,
HOST_NOT_FOUND

On this page

エンドポイント：
パスパラメータ
ヘッダー
リクエスト本文
例
回答
APIリファレンスの活用方法 | Proxy-seller