Hızlı Başlangıç Kılavuzu

KKTC E-Fatura REST API'si ile hızlıca entegrasyon yapmanızı sağlamak için temel adımları ve önemli bilgileri özetler.

1. API Ana ve Test URL'leri

Ana API URL

https://efatura.maliye.gov.ct.tr/api

Test API URL

https://test-efatura.maliye.gov.ct.tr/api

2. Kimlik Doğrulama (Authentication)

Tüm API istekleri için bir Bearer Token gereklidir. Bu token'ı almak için aşağıdaki adımları izleyin:

Token Alma İsteği:

Metot: POST

Content-Type: application/x-www-form-urlencoded

Token URL (Ana):
https://keycloak.maliye.gov.ct.tr/realms/production/protocol/openid-connect/token

Token URL (Test):
https://keycloak.maliye.gov.ct.tr/realms/test/protocol/openid-connect/token

İstek Gövdesi (x-www-form-urlencoded):

Anahtar	Değer
grant_type	password
client_id	efatura-frontend
username	Sisteme kayıtlı kullanıcı adınız.
password	Kullanıcı adınıza ait parolanız.

Yanıt ve Token Kullanımı:

Başarılı bir isteğin ardından dönen JSON objesindeki access_token alanını alın. Bu token'ı diğer API isteklerinizde Authorization başlığı altında Bearer <ACCESS_TOKEN> formatında gönderin.

Örnek Başlık:

Authorization: Bearer [access_token]

3. Temel İşlemler

Fatura Oluşturma/Gönderme

Belirli bir mükellef adına bir veya birden fazla fatura oluşturmak ve göndermek için kullanılır.

Metot: POST

Endpoint: /api/mukellefler/{VKN}/faturalar

Path Parametreleri:

VKN: Fatura kesilecek mükellefin 9 haneli vergi kimlik numarası.

Kimlik Doğrulama: Gerekli (Bearer Token)

Fatura detaylarını içeren JSON objesi (FaturaOlusturRequest şemasına uygun olmalıdır). Detaylı şema için Swagger UI adresine bakınız.

Swagger UI