API Dökümantasyon

Temel Kullanım

Cinsiyet sorgulama için tek yapmanız gereken aşağıdaki adrese sorgu göndermek. Bütün sorgularınızın sonucu JSON verisi olarak geri döner.

İstek
                                    
                                        GET https://genderapi.io/api/?name=abraham&key=<YourAPIKey>
                                    
                                
Alan Veri Tipi Açıklama
name String Sorgulayacağınız isim
key String API anahtarınız
Yanıt
                                    
                                        {
                                            "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"
                                        }
                                    
                                
Alan Veri Tipi Açıklama
name String Sorgulanan isim
q String Gönderilen isim dizisi
gender String Olası değerler: male, female, null
total_names Integer İsteğinize uyan kayıtların veritabanımızdaki sayısı.
probability String Bu değer veritabanımızın doğruluğunu belirler. 100 değeri, cinsiyet sorgunuzdaki sonuçların %100 doğru olduğu anlamına gelir.
status Boolean Yaptığınız isteğinizin sonucu (true ya da false)
duration String İsteğinizin sunucuda işlenme süresi.
used_credits Integer Bu istekte kullanılan kredi sayısı
remaining_credits Integer Paketinizde kalan kredi sayısı
expires Timestamp Paketinizin son kullanma tarihi
server String İsteğinize yanıt veren sunucu

Temel Kurulum

Entegrasyon için temel örnek kodlar.

                                        
                                           <?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');
                                        
                                    
Çalıştır

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);
                                        
                                    
GitHub'ta görüntüle

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"]);
                                        
                                    
Çalıştır

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"];
                                        
                                    
Çalıştır
                                        
                                            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);
                                            });
                                        
                                    
Çalıştır
                                        
                                            //jQuery Code
                                            let API_KEY = ""; //Your API Key
                                            $.genderApi(API_KEY,"honor",function(result){
                                                console.log(result);
                                            });
                                        
                                    
Çalıştır

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>
                                            
                                        
                                    
Çalıştır

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);
                                                    }
                                                }
                                            }
                                        
                                    
Çalıştır

Çoklu İsim Sorgusu

Tek seferde birden fazla sorgulama yapabilirsiniz. İhtiyacınız olan tek şey, isimler arasına "noktalı virgül" koymak.

İstek
                                    
                                        GET https://genderapi.io/api/?name=abraham;john;leyla&key=<YourAPIKey>
                                    
                                
Alan Veri Tipi Açıklama
name String Sorgulayacağınız isim
key String API anahtarınız
Yanıt
                                    
                                        {
                                            "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}
                                            ]
                                        }
                                    
                                
Alan Veri Tipi Açıklama
status Boolean Yaptığınız isteğinizin sonucu (true ya da false)
duration String İsteğinizin sunucuda işlenme süresi.
used_credits Integer Bu istekte kullanılan kredi sayısı
remaining_credits Integer Paketinizde kalan kredi sayısı
expires Timestamp Paketinizin son kullanma tarihi
server String İsteğinize yanıt veren sunucu
q String Gönderilen isim dizisi
names Array Sonuçlar JSON nesnesi olarak bu dizi değişkeni içinde gelir

E-Posta Adresi

Artık kişinin cinsiyetini e-posta adresinden tespit edebiliyoruz. Haydi entegrasyonu inceleyelim.

İstek
                                    
                                        GET https://genderapi.io/api/email?email=innamaria@gmail.com&key=<YourAPIKey>
                                    
                                
Alan Veri Tipi Açıklama
email String E-Posta adresi
key String API anahtarınız
Yanıt
                                    
                                        {
                                            "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"
                                        }
                                    
                                
Alan Veri Tipi Açıklama
email String Sorgulanan e-posta adresi
q String Gönderilen isim dizisi
gender String Olası değerler: male, female, null
total_names Integer İsteğinize uyan kayıtların veritabanımızdaki sayısı.
probability String Bu değer veritabanımızın doğruluğunu belirler. 100 değeri, cinsiyet sorgunuzdaki sonuçların %100 doğru olduğu anlamına gelir.
status Boolean Yaptığınız isteğinizin sonucu (true ya da false)
duration String İsteğinizin sunucuda işlenme süresi.
used_credits Integer Bu istekte kullanılan kredi sayısı
remaining_credits Integer Paketinizde kalan kredi sayısı
expires Timestamp Paketinizin son kullanma tarihi
server String İsteğinize yanıt veren sunucu

Sosyal Medyadan Cinsiyet Bulma

Facebook, Instagram ve Twitter kullanıcılarının cinsiyetini, kullanıcı adlarından sorgulayarak bulabilirsiniz.

İstek {Facebook}
                                    
                                        GET https://genderapi.io/facebook/?q=zuck&key=<YourAPIKey>
                                    
                                
İstek {Twitter}
                                    
                                        GET https://genderapi.io/twitter/?q=jack&key=<YourAPIKey>
                                    
                                
İstek {Instagram}
                                    
                                        GET https://genderapi.io/instagram/?q=kevin&key=<YourAPIKey>
                                    
                                
Alan Veri Tipi Açıklama
q String Kullanıcı Adı, URL veya ID
key String API anahtarınız
Yanıt
                                    
                                        {
                                            "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": "..."
                                            }
                                        }
                                    
                                
Alan Veri Tipi Açıklama
name String Sorgulanan isim
q String Gönderilen isim dizisi
gender String Olası değerler: male, female, null
total_names Integer İsteğinize uyan kayıtların veritabanımızdaki sayısı.
probability String Bu değer veritabanımızın doğruluğunu belirler. 100 değeri, cinsiyet sorgunuzdaki sonuçların %100 doğru olduğu anlamına gelir.
status Boolean Yaptığınız isteğinizin sonucu (true ya da false)
duration String İsteğinizin sunucuda işlenme süresi.
used_credits Integer Bu istekte kullanılan kredi sayısı
remaining_credits Integer Paketinizde kalan kredi sayısı
expires Timestamp Paketinizin son kullanma tarihi
server String İsteğinize yanıt veren sunucu
userInfo JSON Sorguladığınız hesaba ait bazı detaylar

Hata Kodları

API sorgularınızdan dönen hata kodları.

Yanıt
                                    
                                        {
                                            "status":false,
                                            "errno":94,
                                            "errmsg":"invalid or missing key",
                                            "server":"genderapi.io/api"
                                        }
                                    
                                
Hata Kodu (errno) Hata Mesajı (errmsg) Açıklama
10 file content is empty URL dosyasının içeriği boş
11 file is not an image Bu bir resim dosyası değil
12 file save error Dosya kaydetme hatası
13 invalid URL address Geçersiz URL Adresi
50 access denied Yetkisiz IP Adresi. Lütfen erişim yetkilerinizi kontrol ediniz.
90 invalid country code "Kabul edilen ülke kodlarına" bakınız
91 name not set İsteğiniz içerisinde isim bulunamadı
92 too many names Tek seferde en fazla 100 isim sorgusu yapabilirsiniz
93 limit reached Sorgu sınırına ulaşıldı
94 invalid or missing key API anahtarınız bulunamadı
96 user is not found Kullanıcı bulunamadı
97 image file or url are not set URL veya Resim dosyası bulunmadı
500 null error İç sunucu hatası

Sırada ne var?

Hadi hemen bir hesap oluşturun ve sorgu göndermeye başlayın. Kim o? Bir kız mı yoksa erkek mi?