Partner API Nedir ? #

Partner API, Kargonomi ile partnerlik sözleşmesi yapan firmaların Kargonomi arayüzünü kullanmadan, API aracılığıyla bünyelerindeki kullanıcılar adına kargo süreçlerini yürütmelerini sağlar. Bu API, partner firmaların kargo işlemlerini otomatikleştirerek, iş süreçlerini daha verimli ve hızlı hale getirmelerine olanak tanır.

Nasıl Partner Olunur ? #

Kargonomi partneri olmak için iletişim formumuzu doldurarak süreci başlatabilirsiniz. Firmanız hakkında temel bilgileri ve API kullanım amacınızı belirtmeniz sürecin daha hızlı ilerlemesi açısından önemlidir.

Base URL #

Kargonomi Partner API’ye erişim sağlamak için kullanmanız gereken temel URL bilgisi aşağıdaki gibidir:

https://app.kargonomi.com.tr/partner-api/v1/

Kimlik Doğrulama #

API’ye erişim sağlamak için her istekte bir APP KEY kullanmanız gerekmektedir. APP KEY, istek başlıklarına (header) eklenmelidir. APP KEY değeri Kargonomi tarafından iletilecektir.

X-App-Key: {{APP_KEY}}

Endpointler #

Firma Kayıt Kontrolü #

{{base_url}}/company/check-exist - GET

Bu endpoint, bir firmanın Kargonomide kaydının mevcut olup olmadığını kontrol etmek için kullanılır. Telefon numarası, e-posta adresi veya vergi/tc numarası bilgileri ile sorgulama yapılabilir.

curl --location 'https://app.kargonomi.com.tr/partner-api/v1/company/check-exist?email=customer%40customer.com' \
--header 'Accept: application/json' \
--header 'X-App-Key: wBv9s7iibExEVuxH8OoOSHgvUYcMqomy'

Örnek Response :

{
    "user_exist": true
}

Kargonomi Partner Sözleşmesi #

{{base_url}}/partner/agreement - GET

Bu endpoint, Kargonomi’nin partner firmalarına sunduğu kullanıcı sözleşmesine erişimi sağlar.

curl --location 'https://app.kargonomi.com.tr/partner-api/v1/partner/agreement' \
--header 'Accept: application/json' \
--header 'X-App-Key: wBv9s7iibExEVuxH8OoOSHgvUYcMqomy'

Örnek Response :

{
    "data": "PGh0bWw+Li4uPC9odG1sPg=="
}

Not: Yanıt içeriği base64 olarak encode edilmiştir. Bu veriyi kullanabilmek için base64 formatından çözmeniz gerekmektedir.

Kargo Firmaları #

{{base_url}}/partner/shipping-companies - GET

Partner firmanın API aracılığıyla kullanabileceği kargo firmalarını döndürür.

curl --location 'https://app.kargonomi.com.tr/partner-api/v1/partner/shipping-companies' \
--header 'Accept: application/json' \
--header 'X-App-Key: wBv9s7iibExEVuxH8OoOSHgvUYcMqomy'

Örnek Response :

{
    "data": [
        "kolaygelsin",
        "aras",
        "surat",
        "hepsijet",
        "ptt"
    ]
}

Firma Oluşturma #

{{base_url}}/company - POST

Yeni firma oluşturmak içi kullanılır.

curl --location 'https://app.kargonomi.com.tr/partner-api/v1/company' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'X-App-Key: wBv9s7iibExEVuxH8OoOSHgvUYcMqomy' \
--data-raw '{
    "name": "Company Name",
    "email": "company@mail.com",
    "password": "password"
}'

Örnek Response :

{
    "data": {
        "id": 7,
        "name": "Company Name",
        "email": "company@mail.com",
        "code": "VFEV58",
        "created_at": "2024-06-11T22:32:57.000000Z"
    }
}

Firma Adına Access Token Oluşturma #

{{base_url}}/company/access-token - POST

Belirtilen e-posta adresine sahip bir firma için access token oluşturur. Oluşturulan bu access token ile Kargonomi API kullanılmalıdır.

curl --location 'https://app.kargonomi.com.tr/partner-api/v1/company/access-token' \
--header 'Accept: application/json' \
--header 'X-App-Key: wBv9s7iibExEVuxH8OoOSHgvUYcMqomy' \
--form 'email="company@mail.com"'

Örnek Response :

{
    "data": "gB2db5Jy1281gO24FmY5Awk5olsTSnyjcQKIE9803f5c1967"
}

Not : Eğer bir firma zaten Kargonomi üyesi ise Kargonomi panelinden ilgili partner uygulamayı yükleyip access token değerini kendisi almalıdır.

HTTP Status Kodları #

200 OK : İstek başarılı ve yanıt verildi.

201 Created : İstek başarılı ve yeni bir kaynak oluşturuldu.

204 No Content : İstek başarılı, ancak geri dönecek içerik yok. Genellikle bir kaynak silindiğinde döner.

401 Unauthorized : Kimlik doğrulaması gereksinimleri karşılanmadı.

404 Not Found : İstenen kaynak bulunamadı.

422 Unprocessable Entity: İstek başarılı fakat gönderilen veri işlenemiyor. (genelde validation hatası)