ev borcu WordPress sitesi
WordPress REST API: Başlangıç Kılavuzu
Teknik bir alanda çalışıyorsanız API terimini mutlaka duymuşsunuzdur. Biraz kafa karıştırıcı olabilir, ekibiniz ve meslektaşlarınızla API hakkında kolayca konuşabilmeniz için bu kılavuzda tüm şüphelerinizi gidermeye çalıştık.
İçindekiler
API nedir?
REST API nedir?
WordPress'te REST API
WordPress'te REST API'yi entegre etmek için uygulamalar
Zapier:
Google Haritalar:
Kaynatma:
Sosyal Medya Akışı:
REST API Kullanarak Eklentiler Üzerinden Veri Paylaşımı
WordPress'te REST API nasıl çalışır?
WordPress REST API Bileşenleri:
İlk REST API işlevinizi nasıl oluşturabilirsiniz:
REST API Kimlik Doğrulaması
REST API Genel Parametreleri
REST API İstemci ve Sunucu Arasındaki İletişimi Nasıl Başlatır?
Çözüm:
API nedir?
Web Uygulamaları artık bağımsız bir varlık değildir. Daha iyi sonuçlar ve anlık gerçek zamanlı veriler için üçüncü taraf kuruluşlarla iletişim kurmaları gerekir. Üçüncü taraf bileşenlerle iletişim kurmak için bunu yapacak bir ortama ve protokole ihtiyaçları vardır.
Bu tür tanımlanmış protokoller, API veya Uygulama Programlama Arayüzü olarak bilinir. Bu arayüz aracılığıyla iki bağımsız varlık birbiriyle iletişim kurar ve istenen sonucu verir.
Bunu seyahat alanından bir örnekle anlayalım. Müşterilerinin gerçek zamanlı olarak bilet rezervasyonu yapmalarını sağlayan yüzlerce bağımsız havayolu web sitesi vardır. Ancak Skyscanner gibi tüm farklı web sitelerinin sonuçlarının toplandığı, karşılaştırıldığı ve kullanıcıya gösterildiği web siteleri vardır. Bu durumda Skyscanner, Uygulama Programlama Arayüzü veya API'si olarak bilinen tanımlı bir bileşen kullanarak bu yüzlerce veya binlerce web sitesinden veri toplar.
Benzer şekilde, bir akıllı telefonda, dünyanın çeşitli şehirlerinden yerel sunuculardan veri alan hava durumu uygulamaları vardır. Bu sürecin tamamı bir veya diğer API tarafından gerçekleştirilir.
Uygulama geliştiricilerin başka bir yazılım programıyla etkileşime girmesi için güçlü bir araç görevi görür.
REST API nedir?
Temsili Durum Aktarımı API'si , popüler olarak REST API olarak da bilinir. Web programlamada kullanılan mimari stillerden biridir. Diğer mimari stillerden biri Basit Nesne Erişim Protokolüdür , ancak REST daha popüler çünkü daha az bant genişliği tüketir ve bu nedenle web uygulaması durumunda daha hızlı yanıt verir. ASP, PHP, Java, Ruby, Android vb. ile uyumludur.
Tüm popüler tarayıcılar REST kullanır ve bu da onu Bulut tabanlı web uygulamaları için uygun hale getirir. REST API, tüm süreci çeşitli işlem modüllerine bölerek geliştiricilerin işini kolaylaştırır.
Önceki bölümdeki hava durumu uygulaması örneğinde tartışıldığı gibi, uygulamalar çeşitli sunuculara bir veri isteği gönderdiğinde, sunucular istenen verileri öngörülen biçimde (XML veya JSON) göndermek için buna göre yanıt verecektir. Ancak XML veya JSON dosyalarını işlemek ve göndermek zaman alıcıdır ve olması gerektiği kadar gerçek zamanlı değildir.
Bu sunucunun üstesinden gelmek için bir nesne oluşturur ve bu nesneyi temsili bir duruma dönüştürür ve durum veri biçiminde istemciye (uygulamaya) aktarılır.
Herhangi bir web uygulamasının geçtiği 4 kaynak işleme aşaması vardır (CRUD işlemleri olarak da bilinir). Oluşturun, Okuyun, Güncelleyin ve Silin veya POST, GET, PUT AND DELETE gibi HTTP eşdeğerleri var.
RESTful API'leri uygulamanın iki popüler yöntemi Jersey ve Sparing'dir.
REST API'lerinin en popüler kullanımı Mobil/bulut uygulamalarında, sosyal ağ web sitelerinde ve otomatikleştirilmiş iş süreci uygulamalarındadır. API'ler önbellek dostudur, bu nedenle hız ve verimlilik sayesinde daha mobil uyumludurlar.
WPOven – Özel WordPress Barındırma size şunları sağlar –
- ÜCRETSİZ SSD Depolama
- ÜCRETSİZ SSL SERTİFİKASI
- ÜCRETSİZ İş E-postası
- ÜCRETSİZ 100'den fazla premium tema ve eklenti
- ÜCRETSİZ Günlük Site Dışı Yedeklemeler
- ÜCRETSİZ Kötü Amaçlı Yazılım Tarama ve Temizleme
- ÜCRETSİZ WordPress Geliştirme ve Sunucu Desteği
- Adanmış sunucu
Planlarımız 16.61 dolardan başlıyor. Özel VPS, özel kaynaklar, sunucu yığını vb.
WordPress'te REST API
WordPress, basit bir blog platformundan eksiksiz bir Web Uygulaması Geliştirme platformuna dönüşmüştür. Ve diğer tüm uygulama geliştirme araçları gibi, istenen sonuçları sağlamak için Uygulama Programlama Arayüzü'ne (API) ihtiyaç duyar.
WordPress Temsili Durum Transferi (REST) API'si ayrı bir eklenti olarak başlatıldı. İlk olarak Haziran 2013'te Ryan McCue ve Rachel Baker tarafından geliştirildi ve 2015'te çekirdek WP güncellemesine dahil edildi. Büyük popülerlik kazandı ve yüzlerce geliştirici onu daha da geliştirmek için öne çıktı ve o zaman tamamen çekirdeğin bir parçası oldu. WordPress 4.7 sürümünden beri (2016'da). Bu geliştirme, WordPress'in web geliştiricileri için eksiksiz bir çerçeve paketi olma hedefini destekledi.
REST API'nin çekirdek çerçeveye dahil edilmesi, WordPress'in veri işleme işlemlerini ön uç arayüzden ayrı tutarken diğer harici uygulamalar ve sunucularla iletişim kurmasını, entegre etmesini ve veri alışverişinde bulunmasını sağladı ve böylece hızlı hale getirdi. Daha sonra JavaScript/JSON (JavaScript Object Notation) uyumlu sürümü de geliştirildi ve JSON REST API olarak biliniyor, bu da diğer dillerde oluşturulmuş uygulamalarla iletişim kurmayı daha da kolaylaştırıyor.
WordPress REST API'nin temel avantajı, geliştiricilerin uygulamaları PHP'de sıfırdan kodlamak zorunda kalmamaları, WordPress programlarının HTTP istekleri yapabilen ve JSON'u yorumlayabilen diğer herhangi bir programla etkileşime girmesini sağlayabilmeleridir. Diğer bir avantaj, WordPress REST API, AJAX çağrılarını basitleştirdiği ve dolayısıyla verileri eskisinden daha hızlı getirdiği için programları son kullanıcı için daha hızlı ve duyarlı hale getirmektir.
WordPress'te REST API kullanılarak entegre edilebilecek bazı popüler uygulamalar şunlardır:
WordPress'te REST API'yi entegre etmek için uygulamalar
Zapier:
Zapier , Google Docs, MailChimp, Evernote, Buffer, Slack, Trello, Twitter, Facebook, Salesforce ve yaygın olarak kullanılan hemen hemen tüm diğer web uygulamalarını içeren Rest API'yi kullanan yüzlerce uygulamayla etkileşime giren bir platformdur. Bunu kullanarak, basit WordPress web sitenizi, listelenen uygulamalardan herhangi biriyle etkileşimde bulunmak ve veri alışverişi yapmak için güçlendirebilirsiniz, geliştiricinin yalnızca tetikleyicileri ve eylemleri tanımlaması gerekir. Örneğin, bir formdaki verilerin doğrudan Google E-Tablolarınızdan birine eklenmesini istiyorsanız, bunu yalnızca Zapier'den API anahtarını WordPress'inize ekleyerek ve Zapier'deki süreci ve tüm verilerinizi basit bir iletişim formundan tanımlayarak yapabilirsiniz. seçilen elektronik tabloda saklanacaktır. Ne kadar serin?
Google Haritalar:
Google'dan bir API anahtarı kullanarak haritayı web sitenizin ön ucunda gösterebilirsiniz. Daha önce bu, sayfalarınıza bir iframe kodu yerleştirilerek yapılıyordu.
Kaynatma:
Simmer bir yemek tarifi ve yemek kitabı platformudur. Bu geliştiricileri kullanmak, tarifleri ondan alabilir ve kendi web sitelerinde ve mobil web sitelerinde istedikleri kullanıcı arayüzünde görüntüleyebilir.
Sosyal Medya Akışı:
Bir REST API kullanarak artık web sitenizde Facebook, YouTube, Instagram, Twitter gibi ağlardan gelen sosyal medya beslemenizi gösterebilirsiniz.
WordPress Teması ve Eklentisi, Bakım, Destek ve Güncelleme için REST API'sini kullanır
WordPress geliştirme ile ilgileniyorsanız, tema seçeneklerine ve eklenti ayarlarına API Anahtarı seçeneği ekleyerek karşılaşmış olabilirsiniz. Bir API anahtarı eklenip kaydedildikten sonra, WordPress kurulumu artık orijinal geliştirici sunucusuyla iletişim kurabilecektir. API anahtarının kimliği geliştirici sunucusu tarafından doğrulandığında, güncelleme temasını veya eklenti dosyalarını WordPress kurulumuna gönderir.
REST API Kullanarak Eklentiler Üzerinden Veri Paylaşımı
Bu bir eklentiyse, API, verileri WordPress web siteniz ve üçüncü taraf uygulaması arasında senkronize eder.
Örneğin, bir Mailchimp Eklentisi kullanırsanız ve kimliği doğrulanmış bir API anahtarı eklerseniz, katılım e-postalarını doğrudan Mailchimp'e gönderebilirsiniz ve bu, onu hesabınızdaki seçili Mailchimp listesinde saklayacaktır.
WordPress'te REST API nasıl çalışır?
Diğer REST API'leri gibi, WordPress'te de GET, POST, PUT ve DELETE olmak üzere dört temel HTML işleminde çalışır ve API'ye hangi verilerin gerekli olduğunu ve bu verilerle ne yapacağını bildiren ek bir komutla birlikte çalışır. Bunu aşağıdaki bölümlerden geçerek anlayabilirsiniz.
WordPress REST API Bileşenleri:
WordPress'teki Temsili Durum Aktarımı (REST) API'si 5 temel bileşenden oluşur:
- İstekler
- Rotalar/Uç Noktalar
- Tepkiler
- Şema
- Denetleyici Sınıfları
İstekleri Anlamak:
İstekler, bir istemci ile HTTP aracılığıyla gönderilen WP_REST_Request sınıfı kullanılarak uygulanan sunucu arasındaki işlemleri alma biçimindeki iletişimdir. Talepler kayıtlı güzergahlara yapılır.
Rotaları ve Uç Noktaları Anlama:
Her istemci-sunucu isteği belirli bir rota izler ve istenen çıktıyı elde etmek için rota içindeki çeşitli uç noktalara ulaşır. Bu durumda Rotalar etkin bir şekilde URL'lerdir. Bir istek yapıldığında
Bir istek yapıldığında API, mevcut rotaları ve bu rotada mevcut olan uç noktaların her birini gösterir. Daha sonra GET isteğini mevcut uç noktalarla karşılaştıracak ve buna göre yanıtı döndürecektir.
Tepkiler:
Kendinden açıklayıcı bir yanıt olduğu için, API'nin yapılan talebe karşı döndürdüğü istenen verilerdir. Yanıt sınıfı, WP_REST_Response tarafından tanımlanır.
Şema:
Web geliştiricileri, veri almanın tanımlanmış bir yapı içinde yapıldığını zaten anlamışlardır. Bu yapı şema olarak bilinir. İyi tanımlanmış bir şema, kabul ettiği girdi parametrelerinin bir dizinine ve döndürebileceği tüm veri özniteliklerinin bir dizinine sahiptir. Şema, yalnızca yapısına bağlı kalan istekleri doğruladığı için API için bir güvenlik kapağı görevi de görür.
Denetleyici Sınıfları:
Kontrolör, yukarıdaki tüm unsurlar arasında koordinasyon sağlar ve istenen çıktıyı elde etmek ve işlemi tamamlamak için tüm süreci yönetir.
İlk REST API işlevinizi nasıl oluşturabilirsiniz:
WordPress REST API'nin 5 bileşenini zaten öğrendiniz, bu nedenle bir sonraki adım bu API'leri projenize nasıl uygulayacağınızdır. Başlangıç olarak, bir WP REST API'sindeki en popüler Uç Noktalar hakkında bilgi edinmelisiniz.
Bunlar aşağıdaki gibidir:
| KAYNAKLAR | TABAN GÜZERGAH |
| Gönderiler | /wp/v2/yazılar |
| Revizyon Sonrası | /wp/v2/düzeltmeler |
| Kategoriler | /wp/v2/kategoriler |
| Etiketler | /wp/v2/etiketler |
| Sayfalar | /wp/v2/sayfalar |
| Yorumlar | /wp/v2/yorumlar |
| taksonomiler | /wp/v2/taksonomiler |
| medya | /wp/v2/medya |
| Kullanıcılar | /wp/v2/kullanıcılar |
| Yazı Tipleri | /wp/v2/türler |
| Mesaj Durumları | /wp/v2/durumlar |
| Ayarlar | /wp/v2/ayarlar |
Uç noktalara aşinasınız, şimdi her zaman etki alanı URL'nizle başlayan bir HTTP çağrısının nasıl oluşturulacağını anlamanız gerekiyor, örneğin: myxyzdomain.com ve ardından yukarıdaki tabloda belirtilen temel yollardan biri.
REST API Kimlik Doğrulaması
API'de kimlik doğrulama olmadan yapılabilecek iki tür işlev vardır, diğerleri ise kimlik doğrulamaya ihtiyaç duyar.
WordPress'te REST API kimlik doğrulaması, amaca bağlı olarak üç yöntemden herhangi biri ile yapılabilir.
3 yöntem şunlardır:
| Kimlik Doğrulama Yöntemi | Amaç |
| Çerez Kimlik Doğrulaması | Aynı uygulamada çalışan eklentiler/temalar |
| OAuth | 3. taraf uygulamalarla entegre edin, örneğin – mailchimp, instagram, twitter vb. |
| Temel Kimlik Doğrulama (bir eklenti aracılığıyla) | Yalnızca geliştirme ve test için |
Çerez kimlik doğrulaması temelde WordPress'in varsayılan oturum açma işleviyle iyi çalışır. REST API, yalnızca sınırlı bir ömre sahip ve kullanıcıya özel bir WordPress güvenlik belirteci olan "bir kez kullanılan sayı" veya "öğlen" adı verilen bu teknik üzerinde çalışır. Uygulamanızı harici kaynaklar tarafından istismar edilecek şekilde korumak ve programınıza müdahale etmek için kullanılır. Bu tür girişim, genellikle Siteler arası istek sahteciliği (CSRF) veya tek tıklamalı saldırı veya oturum sürme olarak bilinir.
REST API Kimlik Doğrulaması için dahili ve otomatik javascript API kullanılabilir veya alternatif olarak manuel AJAX kimlik doğrulaması da kullanılabilir. Ajax kullanılıyorsa, her istekle birlikte bir öğlen kimlik doğrulama isteği gönderilmelidir. Öğle vakti olmadığında, API bunu kimliği doğrulanmamış bir istek olarak değerlendirecektir.
REST API kimlik doğrulaması örneği
Örnek olarak, yerleşik Javascript istemcisi nonce'yi şu şekilde oluşturur:
|
1
2
3
4
5
|
< ? php
wp_localize_script ( ‘wp-api’ , ‘wpApiSettings’ , array (
‘root’ = > esc_url_raw ( rest_url ( ) ) ,
‘nonce’ = > wp_create_nonce ( ‘wp_rest’ )
) ) ;
|
Bu daha sonra temel modelde kullanılır:
İşte jQuery AJAX kullanarak bir gönderinin başlığını düzenlemeye bir örnek:
REST API kimlik doğrulamasının diğer yolu bir eklenti kullanmaktır, ancak canlı bir uygulamada değil, yalnızca geliştirme sırasında kullanılması önerilir.
REST API Genel Parametreleri
WordPress Temsili Durum Transferi API'si, meta parametreler olarak da bilinen bazı önceden tanımlanmış parametrelere sahiptir. Bunlar aşağıdaki gibidir:
- _jsonp:
Bu meta parametre, verilerden önce bir JavaScript geri çağırma işlevi ekler.
Örnek:
|
1
2
3
4
5
6
7
8
|
<script>
function receiveData ( data ) {
// Do something with the data here.
// For demonstration purposes, we’ll simply log it.
console . log ( data ) ;
}
</script>
<script src = “https://demo.wp-api.org/wp-json/?_jsonp=receiveData” > </script>
|
- _method (veya X-HTTP-Method-Override başlığı)
API işlevini, HTTP yöntemlerini doğru şekilde işlemeyenler de dahil olmak üzere her tür sunucu ve istemciyle uyumlu hale getirmek için bir yöntem geçersiz kılma parametresi kullanılır. - _mektup
Bir zarf parametresi, bir gövde içindeki tüm yanıt verilerini toplar ve ardından bunu talep eden istemciye gönderir. Bu parametreyi kullanmanın ek bir avantajı, tam yanıt verilerine erişmeyi desteklemeyen sunuculara ve istemcilere verilere erişim sağlamasıdır.
Örnek:_Göm
WordPress veya başka herhangi bir geliştirme ortamında, herhangi bir kaynak asla tek başına çalışmaz, her zaman diğer ilgili kaynaklarla bağlantılıdır. Örneğin, bir e-Ticaret ürünü bir veya daha fazla kategoriye, öne çıkan bir görsele, ürün incelemelerine vb. bağlıdır. Bir embed meta parametresi kullanan API, sunucuyu yanıtında gömülü tüm parametreleri göndermeye yönlendirir. İstemci tarafından yapılan HTTP isteklerinin sayısını en aza indirecektir. GET parametresi içinde bir embed parametresi iletilir.
REST API İstemci ve Sunucu Arasındaki İletişimi Nasıl Başlatır?
İki varlık (sunucu ve istemci) arasındaki iletişimi başlatmak için, istemcinin, iletişime izin veren bir sunucuda uyumlu bir API olup olmadığını bilmesi önemlidir. İletişimi başlatmak ve istemciyi keşfetmek için (bu durumda WordPress web uygulaması), bir yönlendirme bağlantısı kullanarak HEADER'dan bir istek gönderir.
Bu iki aşamalı bir süreçtir. 1. adımda, web uygulaması API'yi tanımlar ve keşfeder. İkinci adımda, istemci veya web uygulaması, tüm işlevlerin ve verilerin onun aracılığıyla işlenebileceğini tanımlamalıdır.
API'nin Keşfi
Örnek:
HTML:
|
1
|
< link rel = ‘https://api.w.org/’ href = ‘http://example.com/wp-json/’ / >
|
Javascript:
|
1
2
3
4
5
6
7
8
9
|
// jQuery method
var $ link = jQuery ( ‘link[rel=”https://api.w.org/”]’ ) ;
var api_root = $ link . attr ( ‘href’ ) ;
// Native method
var links = document . getElementsByTagName ( ‘link’ ) ;
var link = Array . prototype . filter . call ( links , function ( item ) {
return ( item . rel === ‘https://api.w.org/’ ) ;
} ) ;
var api_root = link [ 0 ] . href ;
|
XML
XML, Gerçekten Basit Keşif yöntemini kullanır. 2 adımlı bir süreçten oluşur:
Adım 1 – Bağlantı Öğesini kullanarak RSD uç noktasını bulun:
|
1
|
< link rel = “EditURI” type = “application/rsd+xml” title = “RSD” href = “http://example.com/xmlrpc.php?rsd” / >
|
Adım 2 – RSD uç noktasını alın:
|
1
2
3
4
5
6
7
8
9
10
11
12
13
|
<? xml version = “1.0” encoding = “utf-8” ?>
< rsd version = “1.0” xmlns = “http://archipelago.phrasewise.com/rsd” >
< service >
< engineName > WordPress < / engineName >
< engineLink > https : //wordpress.org/</engineLink>
< homePageLink > http : //example.com/</homePageLink>
< apis >
< api name = “WordPress” blogID = “1” preferred = “true” apiLink = “http://example.com/xmlrpc.php” / >
< ! — . . . — >
< api name = “WP-API” blogID = “1” preferred = “false” apiLink = “http://example.com/wp-json/” / >
< / apis >
< / service >
< / rsd >
|
API Yeteneğini Tanımlayın:
Bu adımda, web uygulaması yapılandırmayı kontrol eder ve sağlanan API kullanılarak tüm işlevlerin gerçekleştirilebileceğini görür, örneğin verileri senkronize edin, tema dosyalarını güncelleyin, eklenti destek aboneliklerini belirleyin, vb.
|
1
2
3
4
5
6
7
|
{
“name” : “Example WordPress Site” ,
“namespaces” : [
“wp/v2” ,
“oembed/1.0/”
]
}
|
Çözüm:
Temsili Durum Transfer API'si gelecek için muazzam bir potansiyele sahiptir ve WordPress Paydaşlarını onu kullanmaya başlamaya zorlamıştır. REST API zaten WordPress Çekirdeğine dahil ediliyor ve şimdi Tema ve Eklenti geliştiricileri, tema ve eklenti bakımı, veri entegrasyonu ve diğer uygulama istekleri için API kullanmaya başladı.
REST API, WordPress formunu basit bir CMS'den tam donanımlı bir web uygulaması geliştirme platformuna dönüştürdü. Hâlâ başlangıç aşamasındadır, ancak kendini adamış geliştirme topluluğu kesinlikle tam potansiyelinden yararlanacaktır. Bu çok geniş bir kavramdır ve onu tamamen anlamak için pratik yapmanız gerekir ve onunla neler yapabileceğiniz tamamen hayal gücünüze bağlıdır.