Borkol Docs startpagina

Aan de slag

Bedrijfsprofiel

Lees de openbare bedrijfsgegevens, sociale links en contenttalen van de winkel.

Bekijk als Markdown

Eén endpoint geeft de openbare kant van het bedrijfsprofiel van de merchant: hoe het bedrijf heet en bereikbaar is, waar het is geregistreerd, welke sociale profielen het deelt en in welke talen de content is geschreven. Gebruik het voor een footer, een contactpagina of een taalwisselaar in je storefront. De merchant bewerkt deze waarden in het dashboard onder Instellingen → Bedrijf.

Het endpoint vereist een tenant-API-sleutel met de scope tenant:read, verstuurd als Authorization: Bearer {api_key}. Het is niet afhankelijk van een module. Een sleutel zonder die scope krijgt 403 {"message": "Invalid ability provided."}. De gedeelde tenant-limiet van 120 verzoeken per minuut geldt.

GET /v1/api/business

Geeft de openbare allowlist van het bedrijfsprofiel. Bank-, ondertekenaar-, afzender- en voorwaardenvelden maken er nooit deel van uit. De aanroep maakt geen profiel aan: een winkel die het profiel nog niet heeft ingevuld antwoordt met 200, alle tekstvelden null, social_links als [] en de standaardtaal.

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"]
  }
}

Velden

VeldTypeBeschrijving
trade_namestring of nullNaam waaronder het bedrijf handelt.
legal_namestring of nullGeregistreerde juridische naam.
emailstring of nullOpenbaar contactadres.
phonestring of nullOpenbaar telefoonnummer.
websitestring of nullDe eigen website van het bedrijf.
streetstring of nullStraat van het bedrijfsadres.
house_numberstring of nullHuisnummer.
postal_codestring of nullPostcode.
citystring of nullPlaats.
countrystring of nullLandcode van twee letters, hoofdletters, bijvoorbeeld NL.
registration_numberstring of nullKvK- of ander bedrijfsregistratienummer.
vat_idstring of nullBTW-nummer, hoofdletters.
social_linksarrayDe sociale profielen die de merchant deelt, in de volgorde die is ingesteld. Lege array als er geen zijn. Elk item staat hieronder beschreven.
localestringDe standaardtaal van de winkel, een taaltag zoals nl.
content_localesarray van stringsDe talen waarin de content van de winkel is geschreven. Bevat altijd locale. Dezelfde lijst waartoe gelokaliseerde Objects-waarden worden beperkt.
VeldTypeBeschrijving
platformstringEen van instagram, facebook, x, linkedin, youtube, tiktok, pinterest, threads, bluesky, snapchat, whatsapp, telegram, github, behance, dribbble, vimeo, reddit, discord, mastodon, twitch, spotify, medium, other.
urlstringEen https://-adres. Voor elk platform behalve mastodon en other hoort de host bij dat platform.
labelstring of nullWeergavetekst. Altijd aanwezig voor other, optioneel (vaak null) voor de rest.

De platformlijst kan groeien. Behandel een onbekende platform als een gewone link en toon die met label of url.

Fouten

StatusWanneer
401Ontbrekende of ongeldige API-sleutel.
403De sleutel heeft de scope tenant:read niet.
429Limiet bereikt. Zie Fouten en limieten.