Borkol Docs ana sayfası

Başlarken

İşletme profili

Mağazanın herkese açık işletme bilgilerini, sosyal bağlantılarını ve içerik dillerini okuyun.

Markdown olarak görüntüle

Tek bir endpoint, satıcının işletme profilinin herkese açık yüzünü döndürür: işletmenin adı ve iletişim bilgileri, kayıt bilgileri, bağladığı sosyal profiller ve içeriğinin yazıldığı diller. Storefront altbilgisi, iletişim sayfası veya dil seçici için kullanın. Satıcı bu değerleri panelde Ayarlar → İşletme altından düzenler.

Endpoint, tenant:read kapsamını taşıyan bir tenant API anahtarı ister ve Authorization: Bearer {api_key} olarak gönderilir. Hiçbir modüle bağlı değildir. Bu kapsamı taşımayan anahtar 403 {"message": "Invalid ability provided."} alır. Dakikada 120 istek olan ortak tenant sınırı geçerlidir.

GET /v1/api/business

İşletme profilinin herkese açık izin listesini döndürür. Banka, imzalayan, gönderici ve koşul alanları buna asla dahil değildir. Çağrı profil oluşturmaz: profilini henüz doldurmamış bir mağaza 200 ile yanıt verir, tüm metin alanları null, social_links [] ve varsayılan dil döner.

Request

Request
curl https://api.borkol.com/v1/api/business \
  -H "Authorization: Bearer {api_key}"

Response

Response
{
  "data": {
    "trade_name": "Sunrise Bakery",
    "legal_name": "Sunrise Bakery BV",
    "email": "hello@bakery.example",
    "phone": "+31 20 123 4567",
    "website": "https://bakery.example",
    "street": "Kerkstraat",
    "house_number": "12",
    "postal_code": "2011 AB",
    "city": "Haarlem",
    "country": "NL",
    "registration_number": "12345678",
    "vat_id": "NL123456789B01",
    "social_links": [
      { "platform": "instagram", "url": "https://www.instagram.com/sunrisebakery", "label": null },
      { "platform": "other", "url": "https://bakery.example/blog", "label": "Blog" }
    ],
    "locale": "nl",
    "content_locales": ["nl", "en"]
  }
}

Alanlar

AlanTürAçıklama
trade_namestring veya nullİşletmenin ticaret yaptığı ad.
legal_namestring veya nullKayıtlı yasal ad.
emailstring veya nullHerkese açık iletişim e-postası.
phonestring veya nullHerkese açık telefon numarası.
websitestring veya nullİşletmenin kendi web sitesi.
streetstring veya nullİşletme adresinin sokağı.
house_numberstring veya nullKapı numarası.
postal_codestring veya nullPosta kodu.
citystring veya nullŞehir.
countrystring veya nullİki harfli ülke kodu, büyük harf, örneğin NL.
registration_numberstring veya nullTicaret sicil veya şirket kayıt numarası.
vat_idstring veya nullKDV numarası, büyük harf.
social_linksarraySatıcının bağladığı sosyal profiller, belirlediği sırayla. Yoksa boş array. Her öğe aşağıda açıklanmıştır.
localestringMağazanın varsayılan dili, örneğin nl gibi bir dil etiketi.
content_localesstring arrayMağaza içeriğinin yazıldığı diller. Her zaman locale değerini içerir. Yerelleştirilmiş Objects değerlerinin kısaltıldığı listeyle aynıdır.

Sosyal bağlantı öğeleri

AlanTürAçıklama
platformstringinstagram, facebook, x, linkedin, youtube, tiktok, pinterest, threads, bluesky, snapchat, whatsapp, telegram, github, behance, dribbble, vimeo, reddit, discord, mastodon, twitch, spotify, medium, other değerlerinden biri.
urlstringBir https:// adresi. mastodon ve other dışındaki her platformda host o platforma aittir.
labelstring veya nullGörüntülenen metin. other için her zaman vardır, diğerlerinde isteğe bağlıdır (çoğu zaman null).

Platform listesi büyüyebilir. Tanımadığınız bir platform değerini sıradan bir bağlantı olarak ele alın ve label veya url ile gösterin.

Hatalar

DurumNe zaman
401API anahtarı eksik veya geçersiz.
403Anahtar tenant:read kapsamını taşımıyor.
429Sınıra ulaşıldı. Bkz. Hatalar ve sınırlar.