Como trabalhar com a referência da API

Nesta seção, exploraremos exemplos de interação e como usar parâmetros em APIs

Todos os dados usados neste exemplo são marcadores de posição e servem apenas para fins de demonstração. Ao trabalhar com a API, sempre use seus próprios dados válidos.

Ponto final:

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

Dê uma olhada mais de perto

PATCH - indica o método usado para a consulta

{hostId} - indica a variável a ser substituída por seu valor válido.

Parâmetros do caminho

Nome	Tipo	Descrição
hostId*	Cordas	id do host

Cabeçalhos

Nome	Valor
Tipo de conteúdo	`application/json`
Autorização*	`<YOUR_API_TOKEN>`

Corpo da solicitação

Nome	Tipo	Descrição
nome*	Cordas	novo nome de host

Todos os parâmetros obrigatórios estão marcados com um asterisco (*)

Exemplo

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

As consultas podem ter diferentes conjuntos e tipos de parâmetros, veja a figura abaixo

Vamos considerar um exemplo de uso em várias linguagens de programação

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();
        }

Exemplos de resposta por código de status HTTP. Um "200" indica sucesso, enquanto os códigos "4XX" indicam erros.

Resposta

{
    "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