Postman ile Spotify API
Merhaba, daha önceki yazılarımdan birinde “API Nedir? Yazılımda Ne için Kullanılır?” başlıklı bir medium yazısı paylaşmıştım. Peki bizler bu API’leri nasıl test edebiliriz?
Bir API’niz var ve bu API’nın yeteneklerini görmek çalışma hızı ve durumunu test etmek veya veri içerisinde gelen değerleri sorgulamak için Postman biçilmiş kaftandır.
Postman, uzun kodlara ihtiyaç duymadan API’ları paylaşmak, test etmek, dokümante etmek, monitör etmek için kullanılan ve “rest client” olarak adlandırabileceğimiz bir araçtır.
Postman, Chrome uzantısı olarak kullanabileceğimiz veya direct indirip bilgisayarımıza yükleyebileceğimiz bir uygulamadır. Buradan ister Chrome uzantısı olarak ister bilgisayarınızın işletim sistemine göre yükleyerek kullanabilirsiniz.
🔘 İlk olarak yeni bir Workspace tanımlamamız gerekmektedir.
🔘 Yeni bir Collection tanımlanır. Bunun için yukarıdaki ekran görüntüsünde yer alan “+” butonuna tıklanmalı ve collectiona isim verilmelidir. Ben “Spotify” adını verdiğim bir collection oluşturdum.
🔘 Yeni bir Request eklemek için collection adınızın üstüne gelerek mouse ile sağ click yapılır. Burada çıkan “Add request” seçilir.
Basit olarak Postman kullanımından bahsetmişken gelin bunu bir örnekle daha iyi anlayalım. Bu örneğimde ben Spofiy Api requestlerini kullandım.
İlk olarak tarayıcımdan mevcut spotify hesabım ile login oldum. Daha sonra Spotify Api kullanımı için “TOKEN” bilgisi almamız gerekiyor.
❕ ❕ Belirli süre sonra token bilgisi geçersizleşiyor ve response olarak “The access token expired” uyarısı alabilirsiniz. Aşağıda anlatacağım gibi tekrar token bilgisi almalısınız.
İlk olarak Get Current User’s Profile için bir Get isteği atma örneği yapacağız. Öncelikle yukarıdaki görseldeki gibi kırmızı ok ile gösterilmiş alandaki “GET TOKEN” butonuna tıklayarak mevcut açmış olduğum spotify hesabım için bit token bilgisi alacağım. Bunu bir kez aldıktan sonra bütün diğer istekler için de kullanabilirsiniz.
Spofiy Api requestlerini incelediğimizde endpointlerde belirli kısma kadar ya da kullanılan token bilgisinin aynı olduğunu görebilirsiniz. Bu gibi durumlarda tekrar tekrar yazmak yerine Environments içinde sabit değişkenleri tanımlayabilirsiniz.
Token bilgisi aldığımızı anlattığım görselde de gördüğünüz gibi request metodumuzun “GET”, endpointimizin “https://api.spotify.com/v1/me” olduğu bellidir.
◻️ Params => gerekli parametreleri key, value olarak gönderilebilir.
◻️ Authorization => API’lere erişmek için yetkilendirme gerekmektedir, bir kullanıcı adı / şifre ya da bearer token vs bu kısımdan set edilir.
◻️ Headers => İhtiyacınıza göre header parametreleri buradan gönderilir, content type JSON gibi.
◻️ Body => Bir istekteki ayrıntıların özelleştirebildiği kısımdır.
◻️ Pre-request Script =>Bir request gönderilmeden önce çalışan kısımdır, genellikle request’in doğru çalışması için gereken ortam değişkenlerinin set edildiği yerdir.
◻️ Tests => Bu kısım API’yi test edeceğimiz test scriptlerinin yazıldığı kısımdır.
Header kısmında accept, content-type ve authorization gibi key, value değerlerimi yazdım. Token değerim sabit olduğu için onu “{{token}}” şeklinde belirttim.
Test kısmı için örnek test scriptlerine buradan ulaşabilirsiniz.
Yaptığınız değişiklikler için önce “Save” butonuna tıklanmalıdır. Daha sonra “Send” butonuna tıklanarak ilgili endpointe atılan requestimiz için dönen response değerini (Body) görebilirsiniz.
Response body incelediğimizde mevcut spotify hesabıma ait bilgilerin döndüğünü gözlemleyebilirsiniz.
Collection Export / Import Etmek
Yazdığımız collection’larda set edilmiş tüm parametreleri, yazılmış tüm testleri export ederek paylaşabiliriz. Sağ üst köşedeki Import butonu ile de bizimle paylaşılan dosyayı import edebiliriz. Daha fazla örnek için Github hesabımdaki repositoryde bulunan json dosyasını import ederek daha fazla örnek inceleyebilirsiniz. (https://github.com/fatossgorur/spotifyAPIs-Postman)
Collection sağ tık Export diyerek bilgisayarımıza kaydedebiliriz.
