GeziBilen API Dokümantasyon

Ön İzleme

Bu API, GeziBilen'in hazırlamış olduğu; bloglar, gezi noktaları, gezi listeleri, rotalar, ş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

ParametreTürStatusVarsayılanAçıklama
qstringopsiyonelArama yapmak için kullanılır.
limitnumberopsiyonel20Bir sayfada kaç sonuç gösterileceğini belirler.
typestringopsiyoneltpArama yapılacak içerik tipini belirler.
filterstringopsiyonelnullFiltreleme koşulu.
sortstringopsiyonelnullSıralama koşulu.
offsetnumberopsiyonel0Geçilecek doküman adedi
lnstringopsiyoneltrDoküman dili.

Örnek İstek

const header = {
     api_key = 'key'
}
const url ='https://api.gezibilen.com/search';
const queryParams = {
    q: 'kahve mekanları',
    ln: 'tr',
    type:'routes',
    limit: 1,
    filter: 'shareType=free',
    offset:0
axios.default.get(url, { headers: header, params: queryParams })

Örnek Yanıt

{
  "result": [
   {
 "id": "LOgtNOoOh1zc8UK78HcF",
  "authorId": "A3A6d0xJG6X2i4ltRVDat4cxJMx2",
  "confirm": "ACTIVE",
  "title": { "tr": { "mobile": "İstanbul Kahve Rotası", "web": "İstanbul Kahve Rotası" } },
  "description": { "tr": { "mobile": "string", "web": "string" } },
  "image": { "hash": "string", "url": "string" },
  "isActive": true,
  "shareType": "free",
  "locations": [RouteLocation Array],
  "viewCount": 42,
  "slug": "istanbul-kahve-rotasi"
  }
 ],
 "count": 1,
 "total": 1
}

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
  • Gezi Listesi için: tl
  • Rotalar için: routes
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`
  • Gezi listesi paylaşım tipi filtreleme:
    filter: `shareType=free`
  • Rota paylaşım tipi filtreleme:
    filter: `shareType=free`
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