Ön İzleme

Bu API, GeziBilen’in hazırlamış olduğu; bloglar, gezi noktaları, şehir rehberi, ve bilenbilir gibi çeşitli içeriklerden bilgi almak için bir arama ve filtreleme sistemi sağlar. Türkçe, İngilizce, Almanca ve Rusça dillerini destekler ve pagination özellikleri sunar.

Endpoint

GETapi.gezibilen.com/v1/search

Yetkilendirme

Authentication için api anahtarı gerekir, isteğin header kısmında gönderilir.

const header = { 
     api_key = 'key' 
}

Parametreler

Parametre	Tür	Status	Varsayılan	Açıklama
q	string	opsiyonel		Arama yapmak için kullanılır.
limit	number	opsiyonel	20	Bir sayfada kaç sonuç gösterileceğini belirler.
type	string	opsiyonel	tp	Arama yapılacak içerik tipini belirler.
filter	string	opsiyonel	null	Filtreleme koşulu.
sort	string	opsiyonel	null	Sıralama koşulu.
offset	number	opsiyonel	0	Geçilecek doküman adedi
ln	string	opsiyonel	tr	Doküman dili.

Örnek İstek

const header = { 
     api_key = 'key' 
}
const url ='https://api.gezibilen.com/search';
const queryParams = {
    q: 'boğa heykeli',
     ln: 'tr',
     type:'tp',
     limit: 1,
     filter: 'city=İstanbul',
     offset:0 
axios.default.get(url, 
              { headers: header, params: queryParams })

Örnek Yanıt

{ 
  "result": [ 
   { 
 "id": "ySkF3jJdDlH3KJGfiv2c",
  "title": "Boğa Heykeli",
  "category": [ "Simgesel" ],
  "city": "İstanbul",
  "description": "description", 
  "district": "district", 
 "address": "address", 
  "_geo": { "lat": 40.99044, 
  "lng": 29.02914 }, 
   "photos": [ 
 { 
  "hash": "UNJuAfIA-=IU?GIURjMqoeIUt6?bs;oft6",
  "url": "img_url" 
  },
 { 
  "url": "img_url", 
  "hash":   "UMFF$~V-ot7IVt8V?a?bt7i^M?va#IUR-" 
  }, 
  { 
  "hash": "UOF=q-qWFIoXjbeVRj~pxws;j?tnnjs;t6",
 "url": "img_url" 
  } 
  ], 
  "image": {  "url": "img_url", 
 "hash":  "UNJuAfIA-=IU?GIURjM~qoeIUt6?bs;oft6" 
 } 
  } 
 ],
  "count": 1, 
  "total": 4 
}

Alanlar

qseçili tür (type) içerisinde arama yapılacak kelime/cümle

Varsayılan olarak boş string'dir. ""

limitApi den dönen max doküman adedini ssınırlamak için.

Varsayılan 20

typeApi den istenen veri türü. Bu türler:

Gezi Noktaları için: tp
Blog için: blog
Bilen Bilir için: bb
Şehir Rehberi için: cg

Varsayılan tp

offsetAtlamak istenilen doküman adedi
Örnek: ilk 13 dokümandan sonrakileri getirebilmek için 13

Varsayılan 0

lnDoküman içeriğini hangi dilde istediğimizi belirtiriz.

Türkçe tr
İngilizce en
Almanca de
Rusça ru

Varsayılan tr

filterFilter alanı'nın örnek kullanım şekilleri aşağıdaki gibidir.

Yalnızca şehir filtreleme;
filter: `city=İstanbul`
Yalnızca ilçe filtreleme:
filter: `district=Kadıköy`
Hem şehir hem de ilçe filtreleme:
filter: `city=İstanbul AND district=Kadıköy`

Varsayılan null

sortÇekilecek olan verilerin sıralanması için kullanılan sort field’ının iki çeşit kullanımı mevcuttur. Bunlar artan ve azalan şeklinde sıralama işlemi yapmayı sağlar, hem sayı hem de yazı destekler.

Artan sıralama;
sort: `city:asc`
Azalan sıralama:
sort: `rank:desc`

Varsayılan null