Wie man mit der API-Referenz arbeitet
In diesem Abschnitt werden wir Beispiele für Interaktion und die Verwendung von Parametern in APIs untersuchen
Alle in diesem Beispiel verwendeten Daten sind Platzhalter und nur für Demonstrationszwecke gedacht. Wenn Sie mit der API arbeiten, verwenden Sie immer Ihre eigenen gültigen Daten.
Endpunkt:
Schauen Sie genauer hin
PATCH - gibt die für die Abfrage verwendete Methode an
{hostId} - gibt die zu ersetzende Variable mit ihrem gültigen Wert an.
Pfad-Parameter
Name | Typ | Beschreibung |
|---|---|---|
hostId* | Zeichenfolge | iD des Hosts |
Kopfzeilen
Name | Wert |
|---|---|
Inhalt-Typ |
|
Autorisierung* |
|
Körper der Anfrage
Name | Typ | Beschreibung |
|---|---|---|
name* | Zeichenfolge | neuer Hostname |
Alle obligatorischen Parameter sind mit einem Sternchen (*) gekennzeichnet
Beispiel
https://mobile.proxy-seller.com/api/v1/hosts/21vjv1224n45v7457mvcas/changeNameDie Abfragen können verschiedene Arten von Parametern enthalten, siehe Abbildung unten
Betrachten wir ein Beispiel für die Verwendung in mehreren Programmiersprachen
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();
}Antwortbeispiele nach HTTP-Statuscode. Ein "200" bedeutet Erfolg, während "4XX"-Codes Fehler anzeigen.
Antwort
{
"id": "21vjv1224n45v7457mvcas",
"name": "Host new name",
"number": "101"
}AUTHORIZATION_FAILED,
IP_AUTHORIZATION_FAILED,
HOST_USER_ID_AND_AUTH_DOES_NOT_MATCHINVALID_HOST_ID,HOST_NOT_FOUND