İstek Oluşturma
İstekler üç bileşenden oluşmaktadır:
- API sürümü
- Kaynak yolu
- Çıkış tipi
Uygun bir istek oluşturmak için URI'yi aşağıdaki gibi biçimlendirmeniz gerekir:
https://api.yourepo.com/{version}/{resource}.{output_type}
Bir paket satın alan üyelerin listesini almak için örnek bir istek.
https://api.yourepo.com/1.0/package/buyers.json?package=com.yourepo.source.package
Varsayılan olarak, istekleri HTTP GET istekleridir. Ancak, birçok yöntem POST verilerini göndermenizi gerektirir. Genellikle, GET kullanan tüm okuma isteklerinin standartlarını izleriz ve istekleri POST kullanırız.
Her bir yöntem için gerekli parametrelere ek olarak, API anahtarınızı da göndermeniz gerekir.
Sunucu tarafı API kullanıyorsanız, gizli API anahtarı değerinizle secret_key göndermeniz gerekir.
API sürümü
Her bir istek için kullanmak istediğiniz API'nın hangi sürümünü belirtmeniz gerekir. Şu anda, varsayılan ve mevcut tek sürüm 1.0'dır.
Kaynak yolu
Kaynak yolu, daha sonraki belgelerde kullanımınıza sunulmuştur.
Veri Biçimleri
YouRepo Şu anda sadece bir veri formatını destekliyor, JSON.
Yanıtlar
The response of your request will contain several key things:
- HTTP durum kodu
- API durum
kodu - API yanıt mesajı
Örnek bir istek alalım:
GET https://api.yourepo.com/1.0/package/buyers?package=com.yourepo.source.package&secret_key=YOUR_SECRET_KEY{
"code": 0,
"response": {
"start": 0,
"limit": 25,
"total": "62",
"page": 1,
"buyers": [
{
"nickname": "member1",
"status": "Completed",
"profile_url": "https:\/\/www.yourepo.com\/forum\/profile\/member1"
},
{
"nickname": "member2",
"status": "Completed",
"profile_url": "https:\/\/www.yourepo.com\/forum\/profile\/member2"
},
.....
]
}
}