Skip to content

mazisel/evrapi-api

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Evrapi API örnekleri

Evrapi REST API ile DETSİS kurum araması yapmayı, PDF belgesinden e-Yazışma Paketi (EYP) oluşturmayı ve oluşturulan paket için e-imza oturumu başlatmayı gösteren çalıştırılabilir örnekler.

Hızlı başlangıç

  1. Evrapi panelinden bir API anahtarı oluşturun.
  2. .env.example dosyasını .env olarak kopyalayın.
  3. EVRAPI_API_KEY değerini kendi anahtarınızla değiştirin.
  4. EYP oluşturma örnekleri için PDF_PATH değerini bir PDF dosyasının yolu olarak ayarlayın.
  5. Değişkenleri terminal oturumunuza yükleyin: set -a; source .env; set +a.

Tüm istekler Authorization: Bearer <api-key> header'ını kullanır. Varsayılan API adresi:

https://api.evrapi.com/v1

Endpointler

İşlem Metot Endpoint
DETSİS kurum araması GET /detsis/search?q=Bakanlik&limit=5
EYP paketi oluşturma POST /eyp/create
E-imza oturumu başlatma POST /signer/session

cURL örnekleri

export EVRAPI_API_KEY="evr_live_api_anahtariniz"
export PDF_PATH="/path/to/resmi-yazi.pdf"

./examples/curl/search-detsis.sh "Bakanlik"
./examples/curl/create-eyp.sh

create-eyp.sh yanıtındaki package_id değeriyle imza oturumu başlatabilirsiniz:

export PACKAGE_ID="eyp_paket_kimligi"
./examples/curl/create-signing-session.sh

Node.js örnekleri

Node.js 18 veya üzeri gerekir.

export EVRAPI_API_KEY="evr_live_api_anahtariniz"
export PDF_PATH="/path/to/resmi-yazi.pdf"

node examples/javascript/search-detsis.mjs "Bakanlik"
node examples/javascript/create-eyp.mjs

İmza oturumu için:

export PACKAGE_ID="eyp_paket_kimligi"
node examples/javascript/create-signing-session.mjs

Python örnekleri

Python 3.9 veya üzeri ve requests paketi gerekir.

python3 -m venv .venv
source .venv/bin/activate
pip install -r examples/python/requirements.txt

export EVRAPI_API_KEY="evr_live_api_anahtariniz"
export PDF_PATH="/path/to/resmi-yazi.pdf"

python examples/python/search_detsis.py "Bakanlik"
python examples/python/create_eyp.py

İmza oturumu için:

export PACKAGE_ID="eyp_paket_kimligi"
python examples/python/create_signing_session.py

EYP metadata alanları

/eyp/create isteğindeki metadata alanı JSON string olarak gönderilir.

Alan Açıklama
subject Belgenin konusu
document_number Belge numarası
sender_name Gönderen kurum adı
sender_detsis Gönderen DETSİS kodu
receiver_name Alıcı kurum adı
receiver_detsis Alıcı DETSİS kodu

Gönderen kurum bilgileri istekte verilmezse Evrapi profilindeki kurum bilgileri kullanılır.

Webhook alıcı örnekleri

Evrapi Dashboard > Webhooks ekranından HTTPS endpointinizi ekledikten sonra yalnızca bir kez gösterilen whsec_... sırrını güvenli bir yerde saklayın. Gelen isteğin ham gövdesini Evrapi-Signature header'ı ile doğrulayın.

Yerel geliştirme için Node.js alıcısı:

export EVRAPI_WEBHOOK_SECRET="whsec_webhook_sirriniz"
node examples/javascript/webhook-receiver.mjs

Python alıcısı:

export EVRAPI_WEBHOOK_SECRET="whsec_webhook_sirriniz"
python examples/python/webhook_receiver.py

Örnek alıcılar http://localhost:8787/webhooks/evrapi adresinde dinler. Evrapi yalnızca genel internetten erişilebilen HTTPS adreslerine teslimat yapar; yerel test için HTTPS tüneli kullanın.

Aktif olaylar:

Olay Açıklama
eyp.package.created Yeni EYP paketi oluşturuldu
signer.session.created E-imza oturumu başlatıldı
webhook.test Dashboard üzerinden bağlantı testi gönderildi

Dokümantasyon

Ayrıntılı API açıklamaları için Evrapi API dokümantasyonunu inceleyin.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors