Comment travailler avec la référence API

Dans cette section, nous étudierons des exemples d'interaction et la manière d'utiliser les paramètres dans les API

Toutes les données utilisées dans cet exemple sont des espaces réservés et ne servent qu'à des fins de démonstration. Lorsque vous travaillez avec l'API, utilisez toujours vos propres données valides.

Critère d'évaluation :

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

Regarder de plus près

PATCH - indique la méthode utilisée pour la requête

{hostId} - indique la variable à remplacer par sa valeur valide.

Paramètres du chemin d'accès

Nom	Type	Description
hostId*	Chaîne	identifiant de l'hôte

En-têtes

Nom	Valeur
Content-Type	`application/json`
Autorisation*	`<YOUR_API_TOKEN>`

Corps de la demande

Nom	Type	Description
nom*	Chaîne	nouveau nom d'hôte

Tous les paramètres obligatoires sont marqués d'un astérisque (*)

Exemple

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

Les requêtes peuvent avoir différents ensembles et types de paramètres (voir figure ci-dessous)

Prenons un exemple d'utilisation dans plusieurs langages de programmation

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

Exemples de réponses par code d'état HTTP. Un "200" indique un succès, tandis que les codes "4XX" indiquent des erreurs.

Réponse

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