API-Dokumentation

Grundlegende Verwendung

Das einzige, was Sie für die Geschlechtsabfrage machen müssen, ist es der folgenden Adresse Ihre Abfrage einzugeben und es zu senden. Das Ergebnis all Ihrer Abfragen wird als JSON-Daten zurückgegeben.

Anforderung
                                    
                                        GET https://genderapi.io/api/?name=abraham&key=<YourAPIKey>
                                    
                                
Feld Datentyp Erläuterung
name String Namensabfragung
key String API-Schlüssel

Antwort
                                    
                                        {
                                            "name":"abraham",
                                            "q":"abraham",
                                            "gender":"male",
                                            "total_names":1173,
                                            "probability":99,
                                            "status":true,
                                            "duration":"106ms",
                                            "used_credits":1,
                                            "remaining_credits":472,
                                            "expires":1523404800,
                                            "server":"genderapi.io/api"
                                        }
                                    
                                
Feld Datentyp Erläuterung
name String Abgefragte Name
q String Gesendete Namensreihe
gender String Mögliche Werte: männlich, weiblich, null
total_names Integer Die Anzahl der Datensätze in unserer Datenbank, die Ihrer Anfrage entsprechen
probability String Dieser Wert bestimmt die Korrektheit unserer Datenbank. Ein Wert von 100 bedeutet, dass die Ergebnisse in der Geschlechtsabfrage zu 100% korrekt sind
status Boolean Das Ergebnis Ihrer Anfrage (richtig oder falsch)
duration String Ihre Anfrage wird auf dem Server bearbeitet
used_credits Integer Anzahl des in dieser Anfrage verwendeten Guthabens
remaining_credits Integer Anzahl des verbleibenden Guthabens in Ihrem Paket
expires Timestamp Ablaufdatum Ihres Pakets
server String Der Server, der auf Ihre Anfrage antwortet

Grundinstallation

Grundlegende Beispielcodes für die Integration.

                                        
                                           <?php
                                            function findGender($name) {
                                                $apiKey = ''; //Your API Key
                                                $getGender = json_decode(file_get_contents('https://genderapi.io/api/?key=' . $apiKey . '&name=' . urlencode($name)));
                                                return $getGender->gender;
                                            }
                                            echo findGender('angela');
                                        
                                    
Start

Composer command

                                    
                                        $ composer require genderapi/php-client
                                    
                                
                                        
                                           <?php
                                            use GenderApi\GenderApi;

                                            $genderApi = new GenderApi('Your API Key');
                                            $getGender = $genderApi->findGender('britney');

                                            echo $getGender;

                                            // OR, Get Result
                                            $getResult = $genderApi->result('britney');
                                            print_r($getResult);
                                        
                                    
sieges auf GitHub

Python 3.*

                                        
                                            import json
                                            from urllib.request import urlopen

                                            apiKey = "" #Your API Key
                                            apiUrl = "https://genderapi.io/api/?name=georgi&key=" + apiKey

                                            result = urlopen(apiUrl).read().decode('utf-8')
                                            getGender = json.loads(result)

                                            print( "Gender: " + getGender["gender"]);
                                        
                                    
Start

Python 2.*

                                        
                                            import json
                                            import urllib2

                                            apiKey = "" #Your API Key
                                            apiUrl = "https://genderapi.io/api/?name=irina&key=" + apiKey
                                            getGender = json.load(urllib2.urlopen(apiUrl))

                                            print "Gender: " + getGender["gender"];
                                        
                                    
Start
                                        
                                            import java.io.IOException;
                                            import java.io.BufferedReader;
                                            import java.io.InputStreamReader;
                                            import java.net.URL;
                                            import java.net.HttpURLConnection;
                                            import com.google.gson.Gson;
                                            import com.google.gson.JsonObject;

                                            public class Main {

                                                public static void main(String[] args) {
                                                    try {
                                                        String apiKey = ""; //Your API Key
                                                        URL apiUrl = new URL("https://genderapi.io/api/?name=elvan&key=" + apiKey);
                                                        HttpURLConnection connect = (HttpURLConnection) apiUrl.openConnection();

                                                        if (connect.getResponseCode() != 200) {
                                                          throw new RuntimeException("An server error: " + connect.getResponseCode());
                                                        }

                                                        InputStreamReader iStream = new InputStreamReader(connect.getInputStream());
                                                        BufferedReader bReader = new BufferedReader(iStream);
                                                        Gson gson = new Gson();
                                                        JsonObject jsonOb = gson.fromJson(bReader, JsonObject.class);

                                                        String result = jsonOb.get("gender").getAsString();
                                                        System.out.println("Gender: " + result); // Gender: male
                                                        connect.disconnect();
                                                    } catch (IOException error) {
                                                        error.printStackTrace();
                                                    }
                                                }
                                            }
                                        
                                    

Javascript & jQuery Example

                                    
                                        <!-- Add Javascript & jQuery Library your project -->
                                        <script src="https://genderapi.io/assets/cdn/genderapi.min.js"></script>
                                    
                                
                                        
                                            //Javascript Code
                                            let API_KEY = ""; //Your API Key
                                            genderApi(API_KEY,"honor",function(result){
                                                console.log(result);
                                            });
                                        
                                    
Start
                                        
                                            //jQuery Code
                                            let API_KEY = ""; //Your API Key
                                            $.genderApi(API_KEY,"honor",function(result){
                                                console.log(result);
                                            });
                                        
                                    
Start

Javascript Callback Example

                                        
                                            <html>
                                                <head>
                                                    <meta charset="utf-8">
                                                    <title>GenderAPI.io - Javascript Callback Example</title>
                                                </head>
                                                <body>
                                                    <input readonly id="result"/>
                                                    <script>
                                                    function genderApiResult(result) {
                                                        var gender = document.getElementById('result');
                                                        if (result.gender) {
                                                            gender.value = result.gender;
                                                        } else {
                                                            gender.value = result.errmsg
                                                        }
                                                    }
                                                    </script>
                                                    <!-- Add Javascript Callback Library your project -->
                                                    <!-- Add your API key -->
                                                    <script src="//genderapi.io/api/?name=anna&callback=genderApiResult&key="></script>
                                                </body>
                                            
                                        
                                    
Start

Nugget Packages

                                    
                                        Newtonsoft.Json
                                    
                                
                                        
                                            using System;
                                            using System.Net;
                                            using Newtonsoft.Json.Linq;

                                            namespace GenderAPI
                                            {
                                                public class Program
                                                {
                                                    public static void Main(string[] args)
                                                    {
                                                        String apiKey = ""; //Your API Key
                                                        String name = "markian"; //Name to query

                                                        WebClient client = new WebClient();
                                                        var response = client.DownloadString("https://genderapi.io/api?name=" + name + "&key=" + apiKey);
                                                        JObject jsonData = JObject.Parse(response);
                                                        var gender = jsonData.SelectToken("gender");
                                                        Console.WriteLine("Gender: {0}", gender);
                                                        //Write All Request
                                                        Console.WriteLine(jsonData);
                                                    }
                                                }
                                            }
                                        
                                    
Start

Abfrage von mehreren Namen

Sie können mehrere Abfragen gleichzeitig durchführen. Das einzige, was Sie brauchen, ist ein Semikolon zwischen den Namen zu setzen.

Anforderung
                                    
                                        GET https://genderapi.io/api/?name=abraham;john;leyla&key=<YourAPIKey>
                                    
                                
Feld Datentyp Erläuterung
name String Namensabfragung
key String API-Schlüssel

Antwort
                                    
                                        {
                                            "status":true,
                                            "duration":"64ms",
                                            "used_credits":3,
                                            "remaining_credits":494,
                                            "expires":1523404800,
                                            "server":"genderapi.io/api",
                                            "q":"abraham;john;leyla",
                                            "names":[
                                                {"name":"abraham","q":"abraham","gender":"male","total_names":1173,"probability":99},
                                                {"name":"john","q":"john","gender":"male","total_names":10855,"probability":100},
                                                {"name":"leyla","q":"leyla","gender":"female","total_names":6908,"probability":99}
                                            ]
                                        }
                                    
                                
Feld Datentyp Erläuterung
status Boolean Das Ergebnis Ihrer Anfrage (richtig oder falsch)
duration String Ihre Anfrage wird auf dem Server bearbeitet
used_credits Integer Anzahl des in dieser Anfrage verwendeten Guthabens
remaining_credits Integer Anzahl des verbleibenden Guthabens in Ihrem Paket
expires Timestamp Ablaufdatum Ihres Pakets
server String Der Server, der auf Ihre Anfrage antwortet
q String Gesendete Namensreihe
names Array Die Ergebnisse kommen in dieser Array-Variablen als JSON-Objekt

E-Mail Adrese

Wir können jetzt das Geschlecht der Person von der E-Mail-Adresse erkennen. Schauen wir uns die Integration an

Anforderung
                                    
                                        GET https://genderapi.io/api/email?email=innamaria@gmail.com&key=<YourAPIKey>
                                    
                                
Feld Datentyp Erläuterung
email String E-Mail-Addresse
key String API-Schlüssel

Antwort
                                    
                                        {
                                            "name": "inna",
                                            "q": "innamaria@gmail.com",
                                            "gender": "female",
                                            "total_names": 661,
                                            "probability": 99,
                                            "status": true,
                                            "duration": "0.09s",
                                            "used_credits": 1,
                                            "remaining_credits": 88,
                                            "expires": 1533254400,
                                            "server": "genderapi.io"
                                        }
                                    
                                
Feld Datentyp Erläuterung
email String E-Mail-Adresse, die gesendet wurde
q String Gesendete Namensreihe
gender String Mögliche Werte: männlich, weiblich, null
total_names Integer Die Anzahl der Datensätze in unserer Datenbank, die Ihrer Anfrage entsprechen
probability String Dieser Wert bestimmt die Korrektheit unserer Datenbank. Ein Wert von 100 bedeutet, dass die Ergebnisse in der Geschlechtsabfrage zu 100% korrekt sind
status Boolean Das Ergebnis Ihrer Anfrage (richtig oder falsch)
duration String Ihre Anfrage wird auf dem Server bearbeitet
used_credits Integer Anzahl des in dieser Anfrage verwendeten Guthabens
remaining_credits Integer Anzahl des verbleibenden Guthabens in Ihrem Paket
expires Timestamp Ablaufdatum Ihres Pakets
server String Der Server, der auf Ihre Anfrage antwortet

Geschlecht aus sozialen Medien Erkennen

Sie können das Geschlecht von Facebook, Instagram und Twitter Nutzern finden, indem Sie ihre Benutzernamen abfragen.

Anforderung {Facebook}
                                    
                                        GET https://genderapi.io/facebook/?q=zuck&key=<YourAPIKey>
                                    
                                
Anforderung {Twitter}
                                    
                                        GET https://genderapi.io/twitter/?q=jack&key=<YourAPIKey>
                                    
                                
Anforderung {Instagram}
                                    
                                        GET https://genderapi.io/instagram/?q=kevin&key=<YourAPIKey>
                                    
                                
Feld Datentyp Erläuterung
q String Benutzername, URL oder ID
key String API-Schlüssel

Antwort
                                    
                                        {
                                            "gender": "male",
                                            "total_names": 6040,
                                            "probability": 100,
                                            "name": "mark",
                                            "q": "Mark Zuckerberg",
                                            "status": true,
                                            "duration": "1.20s",
                                            "used_credits": 1,
                                            "remaining_credits": 92,
                                            "expires": 1536796800,
                                            "server": "genderapi.io",
                                            "userInfo": {
                                                "name": "Mark Zuckerberg",
                                                "id": "4",
                                                "profile_image": "..."
                                            }
                                        }
                                    
                                
Feld Datentyp Erläuterung
name String Abgefragte Name
q String Gesendete Namensreihe
gender String Mögliche Werte: männlich, weiblich, null
total_names Integer Die Anzahl der Datensätze in unserer Datenbank, die Ihrer Anfrage entsprechen
probability String Dieser Wert bestimmt die Korrektheit unserer Datenbank. Ein Wert von 100 bedeutet, dass die Ergebnisse in der Geschlechtsabfrage zu 100% korrekt sind
status Boolean Das Ergebnis Ihrer Anfrage (richtig oder falsch)
duration String Ihre Anfrage wird auf dem Server bearbeitet
used_credits Integer Anzahl des in dieser Anfrage verwendeten Guthabens
remaining_credits Integer Anzahl des verbleibenden Guthabens in Ihrem Paket
expires Timestamp Ablaufdatum Ihres Pakets
server String Der Server, der auf Ihre Anfrage antwortet
userInfo JSON Einige Informationen über den Benutzer, über den Sie sich erkundigen

Fehlercodes

Fehlercodes, die von Ihren API-Abfragen zurückgegeben werden.

Antwort
                                    
                                        {
                                            "status":false,
                                            "errno":94,
                                            "errmsg":"invalid or missing key",
                                            "server":"genderapi.io/api"
                                        }
                                    
                                
Fehlercode (errno) Fehlermeldung (errmsg) Erläuterung
10 file content is empty Der Inhalt der URL-Datei ist leer
11 file is not an image Dies ist keine Bilddatei
12 file save error Dateispeicherfehler
13 invalid URL address Ungültige URL-Adresse
50 access denied Nicht autorisierte IP-Adresse. Bitte überprüfen Sie Ihre Zugriffsrechte.
90 invalid country code Siehe "Akzeptierte Ländercodes"
91 name not set Kein Name nach Ihrer Anfrage gefunden
92 too many names Sie können bis zu 100 Namen gleichzeitig abfragen
93 limit reached Abfragelimit erreicht
94 invalid or missing key Ihr API-Schlüssel wurde nicht gefunden
96 user is not found Benutzer wird nicht gefunden
97 image file or url are not set URL- oder Bilddatei wurde nicht gefunden
500 null error Interner Serverfehler

Was kommt als nächstes?

Lassen Sie uns jetzt ein Konto erstellen und beginnen Sie Anfragen zu senden. Wer ist es? Ist es ein Mädchen oder ein Junge?