Etiket Listeleme

Şirketinize ait tüm etiketleri listeleme.

Endpoint

GET /kolaybi/v1/tags

Parametreler

Parametre	Tip	Zorunlu	Açıklama
group	string	Hayır	Etiket grubu ile filtreleme

Örnekler

cURL

# Tüm etiketler
curl -X GET "https://ofis-sandbox-api.kolaybi.com/kolaybi/v1/tags" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Channel: YOUR_CHANNEL"

# Grup ile filtreleme
curl -X GET "https://ofis-sandbox-api.kolaybi.com/kolaybi/v1/tags?group=customer" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Channel: YOUR_CHANNEL"

JavaScript

async function getTags(group = null) {
  const url = new URL("https://ofis-sandbox-api.kolaybi.com/kolaybi/v1/tags");

  if (group) {
    url.searchParams.append("group", group);
  }

  const response = await fetch(url, {
    method: "GET",
    headers: {
      Authorization: `Bearer ${accessToken}`,
      Channel: channel,
    },
  });

  return await response.json();
}

// Kullanım
const allTags = await getTags();
const customerTags = await getTags("customer");

PHP

function getTags($group = null) {
    $url = "https://ofis-sandbox-api.kolaybi.com/kolaybi/v1/tags";

    if ($group) {
        $url .= "?group=" . urlencode($group);
    }

    $ch = curl_init();
    curl_setopt_array($ch, [
        CURLOPT_URL => $url,
        CURLOPT_HTTPHEADER => [
            'Authorization: Bearer ' . $accessToken,
            'Channel: ' . $channel
        ],
        CURLOPT_RETURNTRANSFER => true
    ]);

    $response = curl_exec($ch);
    curl_close($ch);

    return json_decode($response, true);
}

// Kullanım
$allTags = getTags();
$customerTags = getTags('customer');

Python

import requests

def get_tags(group=None):
    url = "https://ofis-sandbox-api.kolaybi.com/kolaybi/v1/tags"
    headers = {
        "Authorization": f"Bearer {access_token}",
        "Channel": channel
    }

    params = {}
    if group:
        params['group'] = group

    response = requests.get(url, headers=headers, params=params)
    return response.json()

# Kullanım
all_tags = get_tags()
customer_tags = get_tags(group='customer')

C#

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Threading.Tasks;
using Newtonsoft.Json;

async Task<dynamic> GetTagsAsync(string group = null)
{
    using var client = new HttpClient();

    var url = "https://ofis-sandbox-api.kolaybi.com/kolaybi/v1/tags";
    if (!string.IsNullOrEmpty(group))
    {
        url += $"?group={Uri.EscapeDataString(group)}";
    }

    var request = new HttpRequestMessage(HttpMethod.Get, url);
    request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", accessToken);
    request.Headers.Add("Channel", channel);

    var response = await client.SendAsync(request);
    var content = await response.Content.ReadAsStringAsync();
    return JsonConvert.DeserializeObject<dynamic>(content);
}

// Kullanım
var allTags = await GetTagsAsync();
var customerTags = await GetTagsAsync("customer");

Yanıt

Başarılı Yanıt

{
  "data": [
    {
      "id": 1,
      "name": "VIP Müşteri",
      "color": "#ff0000",
      "group": "customer",
      "description": "Özel hizmet alan müşteriler",
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-15T10:30:00Z"
    },
    {
      "id": 2,
      "name": "Perakende Satış",
      "color": "#00ff00",
      "group": "sales",
      "description": "Perakende satış kategorisi",
      "created_at": "2024-01-10T14:20:00Z",
      "updated_at": "2024-01-10T14:20:00Z"
    }
  ]
}

Yanıt Alanları

Alan	Tip	Açıklama
id	integer	Etiket ID
name	string	Etiket adı
color	string	Renk kodu
group	string	Etiket grubu
description	string	Etiket açıklaması
created_at	string	Oluşturulma tarihi
updated_at	string	Güncellenme tarihi

Kurallar

Önemli

• Grup: Etiket grubu ile filtreleme yapabilirsiniz
• Renk: Etiketler renk kodları ile görselleştirilebilir
• Benzersiz: Her etiketin benzersiz bir ID'si vardır
• Şirket: Etiketler şirket bazında saklanır
• Kullanım: Etiketler çeşitli dokümanlarda kullanılabilir