Επικυρώστε και μορφοποιήστε διεθνείς ή εθνικούς αριθμούς τηλεφώνου με το GenderAPI v2. Δείτε το απαιτούμενο πλαίσιο χώρας, τα πεδία JSON και τη χρέωση μιας πίστωσης.
Επικύρωση και μορφοποίηση ενός αριθμού τηλεφώνου
Το POST /τηλέφωνο/επικύρωση δέχεται το number και το προαιρετικό πεδίο country. Χρησιμοποιήστε έναν διεθνή αριθμό τηλεφώνου που αρχίζει με +. Για έναν εθνικό αριθμό τηλεφώνου, δώστε έναν κεφαλαίο κωδικό χώρας ISO. Η απόκριση έχει valid, possible, e164, country και country_calling_code μέσα στο data, συν το κοινόχρηστο αντικείμενο meta. Αυτό ελέγχει τη δομή του αριθμού τηλεφώνου, όχι εάν ο συνδρομητής υπάρχει. Κάθε ολοκληρωμένη επικύρωση κοστίζει 1 πίστωση, συμπεριλαμβανομένων των μη έγκυρων αποτελεσμάτων. Η ενδεικτική απάντηση παρακάτω δείχνει έναν μη έγκυρο αριθμό και είναι ανεξάρτητη από το παράδειγμα αιτήματος.
Πεδίο JSON
Τύπος
Κανόνας
number
string
Απαιτείται, 3–32 χαρακτήρες. ASCII ψηφία, κενά, παρενθέσεις και παύλες, με προαιρετικό +. Οι επεκτάσεις και οι αλφαβητικοί χαρακτήρες δεν γίνονται δεκτοί.
country
string
Κωδικός κεφαλαίων ISO 3166-1 alpha-2. Απαιτείται για εθνικό αριθμό τηλεφώνου. Προαιρετικό όταν η τιμή number ξεκινά με +. Παραλείψτε αυτό το πεδίο όταν δεν χρειάζεται.
Επιλέξτε γλώσσα προγραμματισμού.Ρυθμίστε το κλειδί API, και μετά εκτελέστε το παράδειγμα στον διακομιστή σας.
Κάθε αίτημα πρόβλεψης είναι μια νέα χρεώσιμη λειτουργία, συμπεριλαμβανομένων των επαναλήψεων. Αυτά τα παραδείγματα δεν επαναλαμβάνονται αυτόματα. Ελέγξτε την κατάσταση χρέωσης πριν στείλετε άλλο αίτημα.
Πριν την εκτέλεση: πρόσβαση και διαχείριση σφαλμάτων
Εκτελέστε αυτά τα παραδείγματα στον διακομιστή σας. Ρυθμίστε το GENDERAPI_API_KEY στο περιβάλλον διεργασίας στο υπάρχον κλειδί API. Επιβεβαιώστε ότι το meta.access.mode είναι api_key: ένα μη αναγνωρισμένο κλειδί μπορεί να επιστρέψει στη δοκιμή IP.
Οι αποκρίσεις HTTP 4xx και 5xx JSON διατηρούν το σώμα σφάλματος και επιστρέφουν μια κατάσταση εξόδου μη μηδενική. Ελέγξτε τα code, action και meta.usage.billing_status πριν δοκιμάσετε ξανά.
// Server-side Node.js. Save as example.mjs.const apiKey = process.env.GENDERAPI_API_KEY;if (!apiKey) throw new Error("Set GENDERAPI_API_KEY");const body = { "number": "+905321234567"};const response = await fetch("https://api.genderapi.io/api/v2/phone/validate", { method: "POST", headers: { Authorization: `Bearer ${apiKey}`, "Content-Type": "application/json", }, body: JSON.stringify(body), signal: AbortSignal.timeout(30_000), redirect: "error",});const raw = await response.text();if (!(response.headers.get("content-type") ?? "").includes("json")) { throw new Error(`HTTP ${response.status}: expected JSON; request ID ${response.headers.get("x-request-id")}`);}const result = JSON.parse(raw); // Also accepts application/problem+json.if (!response.ok) { console.error(`HTTP ${response.status}`, result); process.exitCode = 1; // A retry is a new operation; inspect billing first.} else { console.log(JSON.stringify(result, null, 2)); // For batches, inspect every item: HTTP 200 may contain item errors.}
Node.js 22+; ενσωματωμένη ανάκτηση. Αποθηκεύστε ως example.mjs και εκτελέστε το node example.mjs. Τεκμηρίωση χρόνου εκτέλεσης
Python
import jsonimport osimport sysimport urllib.errorimport urllib.requestapi_key = os.environ.get("GENDERAPI_API_KEY")if not api_key: raise RuntimeError("Set GENDERAPI_API_KEY")body = json.loads("{\"number\":\"+905321234567\"}")class NoRedirect(urllib.request.HTTPRedirectHandler): def redirect_request(self, req, fp, code, msg, headers, newurl): return Nonerequest = urllib.request.Request( "https://api.genderapi.io/api/v2/phone/validate", method="POST", data=json.dumps(body).encode("utf-8"), headers={ "Authorization": "Bearer " + api_key, "Content-Type": "application/json", },)opener = urllib.request.build_opener(NoRedirect())try: response = opener.open(request, timeout=30)except urllib.error.HTTPError as error: response = error # Keep the Problem Details body on non-2xx responses.with response: status = response.status raw = response.read().decode("utf-8") if "json" not in response.headers.get("Content-Type", ""): raise RuntimeError(f"HTTP {status}: expected a JSON response") result = json.loads(raw)print(json.dumps(result, indent=2), file=sys.stderr if status >= 300 else sys.stdout)if not 200 <= status < 300: sys.exit(1) # Inspect code, action and billing before retrying.# For batches, inspect every item even when HTTP status is 200.
Python 3,10+; τυπική βιβλιοθήκη. Αποθηκεύστε ως example.py και εκτελέστε το python3 example.py. Τεκμηρίωση χρόνου εκτέλεσης
PHP 8+ με την επέκταση cURL. Αποθηκεύστε ως example.php και εκτελέστε το php example.php. Τεκμηρίωση χρόνου εκτέλεσης
Java
import java.net.URI;import java.net.http.HttpClient;import java.net.http.HttpRequest;import java.net.http.HttpResponse;import java.nio.charset.StandardCharsets;import java.time.Duration;public class GenderApiExample { private static String requiredEnv(String name) { String value = System.getenv(name); if (value == null || value.isBlank()) throw new IllegalStateException("Set " + name); return value; } public static void main(String[] args) throws Exception { String apiKey = requiredEnv("GENDERAPI_API_KEY"); String body = "{\"number\":\"+905321234567\"}"; HttpClient client = HttpClient.newBuilder() .connectTimeout(Duration.ofSeconds(10)) .followRedirects(HttpClient.Redirect.NEVER) .build(); HttpRequest request = HttpRequest.newBuilder(URI.create("https://api.genderapi.io/api/v2/phone/validate")) .timeout(Duration.ofSeconds(30)) .header("Authorization", "Bearer " + apiKey) .header("Content-Type", "application/json") .POST(HttpRequest.BodyPublishers.ofString(body, StandardCharsets.UTF_8)) .build(); HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString(StandardCharsets.UTF_8)); if (!response.headers().firstValue("content-type").orElse("").contains("json")) { throw new IllegalStateException("HTTP " + response.statusCode() + ": expected JSON"); } // JSON text; parse with your application's JSON library when integrating. if (response.statusCode() < 200 || response.statusCode() >= 300) { System.err.println(response.body()); // Includes Problem Details. System.exit(1); } System.out.println(response.body()); // For batches, inspect each item's data or error, including on HTTP 200. }}
Java 17+; τυπικό πελάτη HTTP. Αποθηκεύστε ως GenderApiExample.java και εκτελέστε το java GenderApiExample.java. Τεκμηρίωση χρόνου εκτέλεσης
C# / .NET
using System;using System.Net.Http;using System.Net.Http.Headers;using System.Text;using System.Text.Json;string RequiredEnv(string name) => !string.IsNullOrWhiteSpace(Environment.GetEnvironmentVariable(name)) ? Environment.GetEnvironmentVariable(name)! : throw new InvalidOperationException($"Set {name}");var apiKey = RequiredEnv("GENDERAPI_API_KEY");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://api.genderapi.io/api/v2/phone/validate");request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", apiKey);request.Content = new StringContent("{\"number\":\"+905321234567\"}", Encoding.UTF8, "application/json");using var response = await client.SendAsync(request);var raw = await response.Content.ReadAsStringAsync();if (!(response.Content.Headers.ContentType?.MediaType?.Contains("json") ?? false)) throw new InvalidOperationException($"HTTP {(int)response.StatusCode}: expected JSON");using var result = JsonDocument.Parse(raw);if (!response.IsSuccessStatusCode){ Console.Error.WriteLine(result.RootElement); // Preserve Problem Details. Environment.ExitCode = 1;}else{ Console.WriteLine(result.RootElement); // For batches, inspect every item even on HTTP 200.}
Εφαρμογή κονσόλας .NET 8+. Χρησιμοποιήστε το ως Program.cs σε ένα έργο κονσόλας και, στη συνέχεια, εκτελέστε το dotnet run. Τεκμηρίωση χρόνου εκτέλεσης
Go
package mainimport ( "encoding/json" "fmt" "io" "net/http" "os" "strings" "time")func requiredEnv(name string) string { value := os.Getenv(name) if value == "" { panic("Set " + name) } return value}func run() error { apiKey := requiredEnv("GENDERAPI_API_KEY") body := "{\"number\":\"+905321234567\"}" request, err := http.NewRequest("POST", "https://api.genderapi.io/api/v2/phone/validate", strings.NewReader(body)) if err != nil { return err } request.Header.Set("Authorization", "Bearer " + apiKey) request.Header.Set("Content-Type", "application/json") client := &http.Client{ Timeout: 30 * time.Second, CheckRedirect: func(req *http.Request, via []*http.Request) error { return http.ErrUseLastResponse }, } response, err := client.Do(request) if err != nil { return err } defer response.Body.Close() raw, err := io.ReadAll(response.Body) if err != nil { return err } if !strings.Contains(response.Header.Get("Content-Type"), "json") || !json.Valid(raw) { return fmt.Errorf("HTTP %d: expected a JSON response", response.StatusCode) } if response.StatusCode < 200 || response.StatusCode >= 300 { return fmt.Errorf("HTTP %d: %s", response.StatusCode, raw) } fmt.Println(string(raw)) // For batches, inspect every item even on HTTP 200. return nil}func main() { if err := run(); err != nil { fmt.Fprintln(os.Stderr, err) // Keep Problem Details for error handling. os.Exit(1) }}
Go 1,22+; τυπική βιβλιοθήκη. Αποθηκεύστε ως main.go και εκτελέστε το go run main.go. Τεκμηρίωση χρόνου εκτέλεσης
Η εσφαλμένη μορφή εισαγωγής απορρίπτεται με το HTTP 422 πριν από τη χρέωση. Εάν η μορφή αιτήματος είναι σωστή αλλά δεν είναι δυνατή η ανάλυση του αριθμού τηλεφώνου, η λειτουργία μπορεί να επιστρέψει το HTTP 200 με πεδία μορφοποίησης valid: false και null. Αυτή η ολοκληρωμένη επικύρωση κοστίζει 1 πίστωση. Ένας αριθμός που μπορεί να αναλυθεί αλλά δεν είναι έγκυρος μπορεί να εξακολουθεί να έχει τιμή e164. Ελέγξτε το valid; ένας μορφοποιημένος αριθμός από μόνος του δεν αποτελεί απόδειξη εγκυρότητας.
Πεδίο μέσα στο data
Σημασία
valid
Εάν ο αριθμός ταιριάζει με τους κανόνες επικύρωσης του σχεδίου αρίθμησης.
possible
Εάν ο αριθμός έχει ένα εύλογο μήκος για το σχέδιο αρίθμησής του. πιο αδύναμο από το έγκυρο.
e164
Διεθνής μορφοποιημένος αριθμός όταν η ανάλυση είναι επιτυχής, διαφορετικά null.
country
Περιοχή που προέρχεται από τον αριθμό ή null όταν δεν είναι διαθέσιμη. δεν εντοπίζει τον συνδρομητή.
country_calling_code
Αριθμητικός διεθνής κωδικός κλήσης ή null όταν δεν είναι διαθέσιμος.
Έλεγχος ταυτότητας και επανάληψη
Στείλτε το υπάρχον κλειδί API σας χρησιμοποιώντας έλεγχο ταυτότητας Bearer και Content-Type: application/json. Τα παραδείγματα διαβάζουν GENDERAPI_API_KEY από το περιβάλλον. Το πεδίο country απαιτείται για εθνικούς αριθμούς τηλεφώνου και προαιρετικό όταν η τιμή number ξεκινά με +.