digna REST API 2026.11¶

digna REST API, kendi araçlarınızın ve pipeline'larınızın HTTP ve JSON üzerinden digna ile çalışmasını sağlar: projeleri ve denetim sonuçlarını okuyabilir, veri kaynaklarını, veri kümelerini ve öznitelikleri yönetebilir ve denetimleri başlatabilirler; örneğin bir veri yüklemesinin sonunda. Python SDK da aynı API'yi kullanır.

Bu sayfa her isteğin ortak yönlerini ele alır. Kaynak sayfaları her uç noktayı parametreleri, istek gövdesi, yanıtları ve şemalarıyla birlikte listeler:

Temel URL¶

API, digna backend'inin bir parçasıdır. Her yol, backend'in adresinden sonra /v1 ile başlar:

https://digna.example.com/v1/projects

Backend'in adresi, dashboard'un kullandığı adrestir: dashboard/dashboard_config.toml dosyasının [api] bölümündeki baseUrl. Çağıran taraf ile digna aynı makinede değilse her zaman HTTPS kullanın, çünkü her istek bir API anahtarı taşır.

Kimlik Doğrulama¶

Her istek, bir digna kullanıcısının API anahtarını Authorization başlığında gönderir:

Authorization: Bearer <api key>

Bir anahtar oluşturmak için dashboard'un sol alt köşesindeki kullanıcı profilinizi açın, API Keys'e, ardından Add API Key'e tıklayın ve anahtarı kopyalayın. Anahtar yalnızca bir kez gösterilir. Aynı anahtarlar digna MCP Server için de çalışır.

Bir istek, anahtarın ait olduğu kullanıcının izinleriyle çalışır. Oluşturma, değiştirme ve silme işlemleri projede editör rolü gerektirir; aksi takdirde istek 403 koduyla ve You don't have permission to edit this project mesajıyla reddedilir.

İstek Gönderme¶

export DIGNA_API_KEY='<api key>'
curl https://digna.example.com/v1/projects -H "Authorization: Bearer $DIGNA_API_KEY"

Yanıtlar JSON biçimindedir. Listeler bir JSON dizisi olarak döndürülür. İstek gövdeleri de JSON biçimindedir ve Content-Type: application/json ile gönderilir.

Sınırlar ve Filtreler¶

Liste uç noktaları en fazla limit kadar öğe döndürür: varsayılan olarak 200, en fazla 5000. Bu aralığın dışındaki bir değer 400 ile reddedilir. Offset veya sayfa belirteci yoktur; bu nedenle bir listeyi filtreleriyle daraltın, örneğin project_id, data_source_id ya da denetim durumlarında start_date ve end_date ile.

60 saniyeden uzun süren bir istek 408 Request Timeout ile iptal edilir.

Hatalar¶

Bir hata yanıtı, bir kod ve bir mesaj içeren bir JSON gövdesine sahiptir:

{
  "code": "NOT_FOUND",
  "message": "Data set not found"
}

Bir 401 yanıtının message alanı, anahtarla ilgili sorunun ne olduğunu belirtir:

Denetim Çalıştırma¶

Tipik bir entegrasyon, bir veri yüklemesi bittiğinde bir denetim başlatır, tamamlanmasını bekler ve sonucu okur:

1. POST /v1/inspection-requests ile denetimi başlatın. Yanıt, isteğin id değerini içerir.
2. GET /v1/inspection-requests/{inspection_request_id} ile ilerlemesini izleyin. status değeri PENDING durumundan RUNNING üzerinden COMPLETED durumuna geçer ya da FAILED, ABORTED veya CANCELLED olarak sona erer. Artık değişmeyene kadar birkaç saniyede bir yeniden sorgulayın.
3. Denetlenen tarihler için GET /v1/inspection-statuses/data-sources ile sonucu okuyun. Her öğenin genel bir status değeri vardır: 0 (OK), 1 (uyarı), 2 (kritik) veya -1 (durum yok); ayrıca başarılı, belirsiz ve başarısız kontrollerin sayısını içeren modül başına bir durum bulunur.

curl -X POST https://digna.example.com/v1/inspection-requests \
  -H "Authorization: Bearer $DIGNA_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{
    "project_id": 1,
    "include_all_data_sources": true,
    "data_source_ids": [],
    "start_date": "2026-11-06",
    "end_date": "2026-11-06",
    "mode": "DAILY",
    "weekly_mode_weekdays": [],
    "monthly_mode_days": [],
    "use_notification": true
  }'

OpenAPI Belgesi¶

Her digna kurulumu bu API'yi bir OpenAPI 3.1 belgesinde tanımlar ve istekleri denemek için etkileşimli bir Swagger UI sunar:

Release 2026.11 belgesi burada da mevcuttur: openapi.json. Başka bir dilde istemci oluşturmak için bu belgeyi kullanın.