Τεκμηρίωση για προγραμματιστές

Τεκμηρίωση Gender API

Προσδιορίστε φύλο από μικρό ή πλήρες όνομα, διεύθυνση email ή όνομα χρήστη με απλά REST αιτήματα και δομημένες αποκρίσεις JSON.

REST + JSONΑιτήματα GETΜεμονωμένα και μαζικάΠλαίσιο χώρας

Βασική χρήση

Εκτελέστε το πρώτο σας αίτημα Gender API

Στείλτε μία τιμή και λάβετε προβλεπόμενο φύλο, πιθανότητα, χώρα και πληροφορίες χρήσης. Ξεκινήστε με όνομα και χρησιμοποιήστε το ειδικό endpoint όταν διαθέτετε email ή όνομα χρήστη.

Έλεγχος ταυτότητας

Προσθέστε το κλειδί API με την παράμετρο ερωτήματος key. Διατηρείτε τα production keys στον διακομιστή σας· μην εκθέτετε ιδιωτικό κλειδί σε κώδικα browser ή δημόσιο repository.

Διαβάστε τον οδηγό ελέγχου ταυτότητας →
Μηχανικά αναγνώσιμοι πόροι API

Χρησιμοποιήστε την τρέχουσα σύμβαση GenderAPI σε μορφή OpenAPI, Swagger ή Postman.

GET

Φύλο από όνομα

Μικρό ή πλήρες όνομα

Χρησιμοποιήστε το βασικό endpoint όταν η είσοδος είναι μικρό ή πλήρες όνομα.

https://api.genderapi.io/api
cURL
curl "https://api.genderapi.io/api?name=Alice&key=YOUR_API_KEY"

Προαιρετικές παράμετροι

ΠαράμετροςΤύποςΠεριγραφή
countrystringΚωδικός χώρας δύο γραμμάτων, όπως TR ή US.
askToAIbooleanΌταν είναι true, χρησιμοποιεί υποστήριξη AI αν το όνομα δεν βρίσκεται στη βάση δεδομένων.
forceToGenderizebooleanΕπιχειρεί πρόβλεψη για ασυνήθιστες τιμές που μπορεί να μη μοιάζουν με ανθρώπινα ονόματα.
Χρησιμοποιήστε το με προσοχή: Οι αναγκαστικές προβλέψεις για φανταστικά ονόματα, ψευδώνυμα ή τιμές με ασθενές σήμα μπορεί να είναι λιγότερο ακριβείς.
GET

Φύλο από email

Διεύθυνση email

Το endpoint email εξάγει πιθανό όνομα από τη διεύθυνση πριν εκτελέσει τον προσδιορισμό φύλου.

https://api.genderapi.io/api/email
cURL
curl "https://api.genderapi.io/api/email?email=alice.smith%40example.com&country=TR&askToAI=true&key=YOUR_API_KEY"
Το forceToGenderize δεν διατίθεται σε αυτό το endpoint, επειδή το όνομα εξάγεται εσωτερικά.
GET

Φύλο από όνομα χρήστη

Όνομα χρήστη κοινωνικού δικτύου

Χρησιμοποιήστε αυτό το endpoint για usernames, handles και ψευδώνυμα που μπορεί να περιέχουν αναγνωρίσιμο όνομα.

https://api.genderapi.io/api/username
cURL
curl "https://api.genderapi.io/api/username?username=sparkling_unicorn&country=US&askToAI=true&forceToGenderize=true&key=YOUR_API_KEY"

Απόκριση JSON

Κατανοήστε την απόκριση GenderAPI

Και τα τρία endpoints χρησιμοποιούν την ίδια βασική δομή απόκρισης.

200 OK
{
  "status": true,
  "used_credits": 1,
  "remaining_credits": 4999,
  "expires": 1743659200,
  "q": "Alice",
  "name": "alice",
  "gender": "female",
  "country": "US",
  "total_names": 325,
  "probability": 98,
  "duration": "4ms"
}

Πεδία απόκρισης

ΠεδίοΤύποςΠεριγραφή
statusbooleanΔείχνει αν το αίτημα ολοκληρώθηκε επιτυχώς.
used_creditsintegerΜονάδες που καταναλώθηκαν από αυτό το αίτημα.
remaining_creditsintegerΜονάδες που απομένουν μετά το αίτημα.
expiresintegerΧρόνος λήξης πακέτου ως χρονική σήμανση UNIX.
qstringΤο αρχικό ερώτημα ονόματος, email ή ονόματος χρήστη.
namestringΤο κανονικοποιημένο ή εξαγόμενο μικρό όνομα.
genderstringΠροβλεπόμενο φύλο: male, female ή "null".
countrystringΠιθανότερος κωδικός χώρας ISO 3166-1 alpha-2.
total_namesintegerΠλήθος εγγραφών ονομάτων στις οποίες βασίζεται η πρόβλεψη.
probabilityintegerΠιθανότητα πρόβλεψης ως ποσοστό.
durationstringΧρόνος επεξεργασίας του αιτήματος στον διακομιστή.

Κωδικοποιείτε πάντα τις τιμές URL

Τα κενά και οι ειδικοί χαρακτήρες πρέπει να κωδικοποιούνται από τον HTTP client. Για παράδειγμα, χρησιμοποιήστε sparkling%20unicorn αντί για απλό κενό.

Συνεχίστε την υλοποίηση

Επιλέξτε τον οδηγό για τη ροή εργασίας σας

Αιτήματα ονόματοςΜεμονωμένα και μαζικά παραδείγματα →Βιβλιοθήκες clientΧρησιμοποιήστε τη γλώσσα που προτιμάτε →Διαχείριση σφαλμάτωνΚαταστάσεις και κωδικοί σφαλμάτων →