API Sürümü 1.1

Bu dokümantasyon, uygulamanızı kaydetme, yapılandırma ve geliştirmenize nasıl yardımcı olacağını açıklar

Uygulama Oluştur

Uygulamanızın API'larımıza erişebilmesi için uygulamanızı aşağıdaki yöntemle kaydetmeniz gerekir Uygulama Panosu. Kayıt, kim olduğunuzu bilmemize yardımcı olan ve uygulamanızı diğer uygulamalardan ayıran bir Uygulama Kimliği oluşturur.

1. Yeni bir Uygulama oluşturmanız gerekecek Yeni Uygulama Oluştur
2. Uygulamanızı oluşturduktan sonra alacaksınız app_id ve app_secret

İle Giriş Yap

Giriş Yap sistemi, insanların uygulamanıza hesap oluşturmasını ve giriş yapmasını hızlı ve kolay hale getirir. Giriş Yap sistemi iki senaryo sunar: kimlik doğrulama ve kişilerin verilerine erişim izni isteme. Bu sistemi yalnızca kimlik doğrulama için veya hem kimlik doğrulama hem de veri erişimi için kullanabilirsiniz.

1. OAuth oturum açma sürecini başlatmak için uygulamanız için şu şekilde bir bağlantı kullanmalısınız:

   <a href="https://turkbelediye.com/api/oauth?app_id=YOUR_APP_ID">Log in With Türk Belediye</a>

   Kullanıcı, bu şekilde bir Giriş Yap sayfasına yönlendirilecek

   
2. Kullanıcı uygulamanızı kabul ettiğinde, kullanıcı şu şekilde App Redirect URL'nize yönlendirilecektir auth_key bu şekilde:

   https://mydomain.com/my_redirect_url.php?auth_key=AUTH_KEY

   Bu auth_key Sadece bir kez kullanılmak üzere geçerlidir; bir kez kullandıktan sonra tekrar kullanamazsınız. Yeni bir kod oluşturmak için kullanıcıyı tekrar giriş yap bağlantısına yönlendirmeniz gerekir.

Erişim Belirteci

Uygulamanız için kullanıcı onayını aldıktan ve Giriş Yap penceresinden geri döndükten sonra auth_key bu, artık API'larımızdan veri almaya hazır olduğunuz ve bu süreci başlatmak için uygulamanızı yetkilendirip bir erişim belirteci almanız gerektiği anlamına gelir access_token bunu nasıl alacağınızı öğrenmek için adımlarımızı izleyebilirsiniz.

1. Bir erişim belirteci almak için aşağıdaki uç noktaya şu şekilde bir HTTP GET isteği yapın:

           <?php
   
           $app_id = "YOUR_APP_ID"; // your app id
           $app_secret = "YOUR_APP_SECRET"; // your app secret
           $auth_key = $_GET['auth_key']; // the returned auth key from previous step
   
           // Prepare the POST data
           $postData = [
             'app_id' => $app_id,
             'app_secret' => $app_secret,
             'auth_key' => $auth_key
           ];
   
           // Initialize cURL
           $ch = curl_init('https://turkbelediye.com/api/authorize');
   
           // Set cURL options for POST
           curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
           curl_setopt($ch, CURLOPT_POST, true);
           curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($postData));
   
           // Execute request
           $response = curl_exec($ch);
   
           // Check for cURL errors
           if (curl_errno($ch)) {
             die('cURL error: ' . curl_error($ch));
           }
   
           curl_close($ch);
   
           // Decode the JSON response
           $json = json_decode($response, true);
   
           // Use the access token if available
           if (!empty($json['access_token'])) {
             $access_token = $json['access_token']; // your access token
           }
           ?>
           

   Bu access_token Sadece 1 saat geçerli olup süresi dolduğunda kullanıcıyı tekrar giriş yap bağlantısına yönlendirerek yeni bir tane oluşturmanız gerekir.

API'ler

Bir kez aldığınızda access_token Artık sistemimizden aşağıdaki parametreleri destekleyen HTTP GET istekleriyle bilgi alabilirsiniz

Kullanıcı bilgilerini şu şekilde alabilirsiniz

        if(!empty($json['access_token'])) {
            $access_token = $json['access_token']; // your access token
            $get = file_get_contents("https://turkbelediye.com/api/get_user_info?access_token=$access_token");
        }
        

Sonuç şöyle olacak:

        {
          "user_info": {
          "user_id": "",
          "user_name": "",
          "user_email": "",
          "user_firstname": "",
          "user_lastname": "",
          "user_gender": "",
          "user_birthdate": "",
          "user_picture": "",
          "user_cover": "",
          "user_registered": "",
          "user_verified": "",
          "user_relationship": "",
          "user_biography": "",
          "user_website": ""
          }
        }