API ile Veri Erişimi

Base URL: https://api.tecof.com/api/v1
Authorization: Bearer tcfi_...

import { tecof } from "@/lib/tecof";

const api = tecof.client(installationId);

{
  "success": true,
  "message": "İşlem başarılı",
  "messageCode": "success",
  "data": [],
  "totalData": 128
}

import { TecofApiError } from "@tecof/app-sdk";

try {
  const order = await api.orders.get("TCF-1001");
} catch (err) {
  if (err instanceof TecofApiError && err.code === "insufficient-scope") {
    console.warn("Eksik kapsam:", err.data); // { required, missing }
  } else {
    throw err;
  }
}

import type { TecofApp } from "@tecof/app-sdk";

type ApiClient = ReturnType<TecofApp["client"]>;

export async function syncChangedOrders(api: ApiClient, since: string) {
  const limit = 200;
  for (let page = 1; ; page++) {
    const batch = await api.orders.list({ updatedSince: since, page, limit });
    for (const order of batch) {
      // siparişi işle
    }
    if (batch.length < limit) break;
  }
}

curl "https://api.tecof.com/api/v1/orders?paymentStatus=paid&limit=20" \
  -H "Authorization: Bearer $TECOF_INSTALLATION_TOKEN"

const paid = await api.orders.list({ paymentStatus: "paid", limit: 20 });
const order = await api.orders.get("TCF-1001");

{
  "id": "6720bb00cc11dd22ee33ff44",
  "orderNumber": "TCF-1001",
  "status": "confirmed",
  "paymentStatus": "paid",
  "currency": "TRY",
  "orderedAt": "2026-10-10T09:15:00.000Z",
  "createdAt": "2026-10-10T09:15:00.000Z",
  "updatedAt": "2026-10-10T09:16:12.000Z",
  "cancelledAt": null,
  "cancelReason": null,
  "customer": {
    "id": "66f1aa00bb11cc22dd33ee77",
    "firstName": "Örnek",
    "lastName": "Müşteri",
    "email": "musteri@example.com",
    "phone": "+905550000000"
  },
  "billingAddress": {
    "firstName": "Örnek", "lastName": "Müşteri", "company": "", "phone": "+905550000000",
    "email": "musteri@example.com", "country": "TR", "city": "İstanbul", "district": "Kadıköy",
    "zip": "34000", "line1": "Örnek Mah. Deneme Sk. No: 1", "line2": "", "identityNumber": "11111111111",
    "invoiceType": "individual", "taxNumber": "", "taxOffice": ""
  },
  "shippingAddress": {
    "firstName": "Örnek", "lastName": "Müşteri", "company": "", "phone": "+905550000000",
    "email": "musteri@example.com", "country": "TR", "city": "İstanbul", "district": "Kadıköy",
    "zip": "34000", "line1": "Örnek Mah. Deneme Sk. No: 1", "line2": "", "identityNumber": "",
    "invoiceType": "individual", "taxNumber": "", "taxOffice": ""
  },
  "lineItems": [
    {
      "id": "li_1", "productId": "66f2aa00bb11cc22dd33ee88", "variantId": "66f2aa00bb11cc22dd33ee99",
      "name": "Pamuklu Tişört", "variantTitle": "S / Siyah", "sku": "TS-S",
      "quantity": 2, "unitPrice": 500, "totalPrice": 1000,
      "taxRate": 20, "taxAmount": 166.67, "discountAmount": 0, "netTotal": 833.33, "taxIncluded": true,
      "personalizationTotal": 0
    }
  ],
  "shippingLines": [
    { "title": "Standart Kargo", "carrier": "Örnek Kargo", "deliveryMethod": "standard", "price": 50 }
  ],
  "discountLines": [],
  "totals": {
    "subtotal": 1000, "discount": 0, "shipping": 50, "paymentFee": 0,
    "tax": 175, "taxAddedToTotal": 0, "total": 1050,
    "pricesIncludeTax": true, "shippingTaxRate": 20, "shippingTaxAmount": 8.33, "shippingTaxIncluded": true
  },
  "payment": {
    "provider": "iyzico", "paidAmount": 1050, "paidAt": "2026-10-10T09:16:10.000Z",
    "installmentCount": 1, "cardAssociation": "VISA", "lastFourDigits": "0000"
  },
  "packages": [],
  "note": "",
  "tags": [],
  "salesChannelId": null
}

const customers = await api.customers.list({ search: "musteri@example.com" });
const customer = await api.customers.get("66f1aa00bb11cc22dd33ee77");

{
  "id": "66f1aa00bb11cc22dd33ee77",
  "firstName": "Örnek", "lastName": "Müşteri", "fullName": "Örnek Müşteri",
  "email": "musteri@example.com", "phone": "+905550000000",
  "accountStatus": "active", "isEmailVerified": true, "preferredLanguage": "tr",
  "groupIds": [], "tagIds": [], "note": "",
  "addresses": [
    {
      "id": "addr_1", "title": "Ev", "firstName": "Örnek", "lastName": "Müşteri",
      "phone": "+905550000000", "country": "TR", "city": "İstanbul", "district": "Kadıköy",
      "zip": "34000", "line1": "Örnek Mah. Deneme Sk. No: 1", "line2": "", "isDefault": true
    }
  ],
  "totalOrders": 3, "totalSpent": 2450, "firstOrderAt": "2026-08-01T10:00:00.000Z",
  "lastOrderAt": "2026-10-10T09:15:00.000Z",
  "createdAt": "2026-08-01T09:58:00.000Z", "updatedAt": "2026-10-10T09:15:00.000Z"
}

{
  "productId": "66f2aa00bb11cc22dd33ee88",
  "productName": "Pamuklu Tişört",
  "productSlug": "pamuklu-tisort",
  "variantId": "66f2aa00bb11cc22dd33ee99",
  "sku": "TS-S",
  "barcode": "8690000000000",
  "title": "S / Siyah",
  "price": 500,
  "stock": 12,
  "locations": [{ "locationId": "66f3aa00bb11cc22dd33ee00", "name": "Ana Depo", "quantity": 12 }],
  "updatedAt": "2026-10-10T08:00:00.000Z"
}

const lowStock = await api.inventory.list({ lowStock: true });

const products = await api.products.list({ status: "active", limit: 50 });
const product = await api.products.get("pamuklu-tisort");

{
  "_id": "66f2aa00bb11cc22dd33ee88",
  "slug": "pamuklu-tisort",
  "name": [{ "code": "tr", "value": "Pamuklu Tişört" }],
  "status": "active",
  "type": "variable",
  "totalStock": 12,
  "variantCount": 2,
  "variants": [
    {
      "_id": "66f2aa00bb11cc22dd33ee99", "sku": "TS-S", "barcode": null,
      "price": 500, "compareAtPrice": 650, "weight": 300, "isActive": true,
      "stock": 12, "stocks": [{ "stockLocationId": "66f3aa00bb11cc22dd33ee00", "quantity": 12 }],
      "variantValues": [{ "variantTypeId": "…", "variantValueId": "…" }]
    }
  ]
}

curl "https://api.tecof.com/api/v1/tools/apply_stock_count" \
  -H "Authorization: Bearer $TECOF_INSTALLATION_TOKEN"

// Girdi alanlarını aracın inputSchema'sına göre doldurun
const result = await api.tools.call("apply_stock_count", input);

curl -X POST "https://api.tecof.com/api/v1/tools/apply_stock_count" \
  -H "Authorization: Bearer $TECOF_INSTALLATION_TOKEN" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: stock-sync-2026-10-10-0001" \
  -d @input.json

import { TecofApiError } from "@tecof/app-sdk";

async function callWithConfirm(api: ApiClient, name: string, input: Record<string, unknown>) {
  try {
    return await api.tools.call(name, input);
  } catch (err) {
    if (err instanceof TecofApiError && err.code === "confirmation-required") {
      const { confirmId, summary } = err.data as { confirmId: string; summary: string };
      // summary'yi kaydedin ya da kullanıcıya gösterin; onaylandıysa aynı girdiyle tekrar çağırın
      return api.tools.call(name, { ...input, confirm: true, confirmId });
    }
    throw err;
  }
}

const installation = await api.installation();

{
  "installationId": "6720aa00bb11cc22dd33ee55",
  "status": "active",
  "installedAt": "2026-10-10T08:00:00.000Z",
  "isTestInstall": false,
  "scopes": ["orders:read", "customers:read", "products:read"],
  "pendingScopes": [],
  "merchant": {
    "id": "66f0c0ffee0000000000abcd", "name": "Örnek Mağaza", "productType": "ecommerce",
    "languages": ["tr", "en"], "defaultLanguage": "tr", "currency": "TRY"
  },
  "app": { "clientId": "tcfa_xxxxxxxxxxxxxxxx", "slug": "isbasi", "name": "Logo İşbaşı", "configVersion": 3 },
  "subscription": { "planKey": "standart", "status": "active", "trialEndsAt": null, "currentPeriodEnd": "2026-11-10T09:16:10.000Z" }
}

curl "https://api.tecof.com/api/v1/app/settings" -H "Authorization: Bearer $TECOF_INSTALLATION_TOKEN"

{ "success": true, "messageCode": "success", "data": { "settings": { "invoiceMode": "draft" }, "updatedAt": "2026-10-10T09:00:00.000Z" } }

curl -X PUT "https://api.tecof.com/api/v1/app/settings" \
  -H "Authorization: Bearer $TECOF_INSTALLATION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "settings": { "invoiceMode": "issued" }, "merge": true }'

# Yazma
curl -X PUT "https://api.tecof.com/api/v1/app/secrets/isbasiApiKey" \
  -H "Authorization: Bearer $TECOF_INSTALLATION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "value": "örnek-api-anahtarı" }'
# → { "data": { "key": "isbasiApiKey", "updatedAt": "…" } }

# Listeleme (değer dönmez)
curl "https://api.tecof.com/api/v1/app/secrets" -H "Authorization: Bearer $TECOF_INSTALLATION_TOKEN"
# → { "data": [ { "key": "isbasiApiKey", "updatedAt": "…", "lastReadAt": "…", "length": 18 } ] }

# Okuma
curl "https://api.tecof.com/api/v1/app/secrets/isbasiApiKey" -H "Authorization: Bearer $TECOF_INSTALLATION_TOKEN"
# → { "data": { "key": "isbasiApiKey", "value": "örnek-api-anahtarı", "updatedAt": "…" } }

curl -X PUT "https://api.tecof.com/api/v1/metafields" \
  -H "Authorization: Bearer $TECOF_INSTALLATION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "ownerType": "order",
    "ownerId": "6720bb00cc11dd22ee33ff44",
    "key": "invoiceNumber",
    "type": "string",
    "value": "ABC2026000000123",
    "visibility": "shared",
    "panel": { "label": { "tr": "İşbaşı fatura no", "en": "İşbaşı invoice no" }, "show": true }
  }'

curl "https://api.tecof.com/api/v1/metafields?ownerType=order&ownerId=6720bb00cc11dd22ee33ff44&namespace=isbasi" \
  -H "Authorization: Bearer $TECOF_INSTALLATION_TOKEN"

{
  "id": "6720ee00ff11aa22bb33cc77",
  "namespace": "isbasi",
  "ownerType": "order",
  "ownerId": "6720bb00cc11dd22ee33ff44",
  "key": "invoiceNumber",
  "type": "string",
  "value": "ABC2026000000123",
  "visibility": "shared",
  "panel": { "label": { "tr": "İşbaşı fatura no", "en": "İşbaşı invoice no" }, "show": true },
  "own": true,
  "updatedAt": "2026-10-10T09:20:00.000Z"
}

curl -X POST "https://api.tecof.com/api/v1/app/events" \
  -H "Authorization: Bearer $TECOF_INSTALLATION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "name": "invoice.created", "data": { "orderId": "6720bb00cc11dd22ee33ff44", "invoiceNumber": "ABC2026000000123" } }'

const catalog = await api.events.catalog();
// [{ slug: "kargo", appName: "Örnek Kargo", event: "app.kargo.shipment.created", description: { tr: "…", en: "…" } }]