Sağlayıcı alanları (ayar şeması)

Tek bir sağlayıcının tanımını ve hesap eklerken settings altında gönderilecek alanların şemasını almak için bu endpoint kullanılır. Alan listesi sağlayıcıya göre değiştiğinden, fatura hesabı oluşturma formunu bu yanıta göre dinamik kurabilirsiniz.

Bu uç yalnızca Geliştirici paketlerinde açıktır (bkz. sağlayıcı listesi sayfasındaki uyarı).

İstek

GET /api/integrations/invoice/providers/{id}
Accept: application/json
Authorization: Bearer YOUR_API_KEY

{id}, sağlayıcı listesinden alınan sağlayıcı kimliğidir (ör. mysoft). Bilinmeyen kimlikte 404 döner.

Örnek istekler

💻 cURL

curl -X GET "https://app.faturaentegrator.com/api/integrations/invoice/providers/mysoft" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY"

🐘 PHP

<?php
$ch = curl_init('https://app.faturaentegrator.com/api/integrations/invoice/providers/mysoft');
curl_setopt_array($ch, [
    CURLOPT_HTTPHEADER => ['Accept: application/json', 'Authorization: Bearer YOUR_API_KEY'],
    CURLOPT_RETURNTRANSFER => true,
]);
$data = json_decode(curl_exec($ch), true);
curl_close($ch);

🟢 Node.js

const res = await fetch('https://app.faturaentegrator.com/api/integrations/invoice/providers/mysoft', {
  headers: { Accept: 'application/json', Authorization: 'Bearer YOUR_API_KEY' },
});
const data = await res.json();

🐍 Python

import requests
r = requests.get(
    'https://app.faturaentegrator.com/api/integrations/invoice/providers/mysoft',
    headers={'Accept': 'application/json', 'Authorization': 'Bearer YOUR_API_KEY'},
)
data = r.json()

Yanıt

Sağlayıcı listesindeki alanlara ek olarak fields dizisi döner.

{
  "data": {
    "id": "mysoft",
    "title": "Mysoft",
    "can_check_connection": true,
    "capabilities": { "...": "..." },
    "fields": [
      {
        "key": "username",
        "type": "text",
        "label": "E-Posta",
        "required": true,
        "description": "Portal girişinde kullanılan e-posta adresiniz.",
        "placeholder": null,
        "default": null,
        "options": null
      },
      {
        "key": "password",
        "type": "text",
        "label": "Parola",
        "required": true,
        "description": "Portal girişinde kullanılan parolanız.",
        "placeholder": null,
        "default": null,
        "options": null
      }
    ]
  }
}

fields[] alanları

Alan	Tip	Açıklama
key	string	Hesap eklerken settings nesnesinde kullanılacak anahtar (settings.<key>).
type	string	Alan tipi: text, password, number, select. Doğrulama kuralını belirler (aşağıya bakın).
label	string	Görünen etiket. Doğrulama hatalarında alan adı olarak bu etiket kullanılır.
required	boolean	true ise settings.<key> zorunludur; false ise boş bırakılabilir.
description	string | null	Alanın nereden alınacağını anlatan açıklama.
placeholder	string | null	Örnek değer.
default	mixed | null	Varsayılan değer. Gönderilmeyen alana otomatik uygulanmaz; formunuzda ön değer olarak kullanın.
options	array | null	Yalnızca select tipinde dolu gelir: [{ "value": "...", "label": "..." }]. Gönderilen değer value listesinden biri olmalıdır.

type değerine göre doğrulama

type	Beklenen değer
text, password	string
number	sayısal değer
select	options[].value içinden bir değer

fields boş dizi dönen sağlayıcılarda (ör. test amaçlı Test Entegratör, id: dummy) hesap eklerken settings göndermeniz gerekmez.