Provider API dokümantasyonu

Tüm uç noktalar, alanlar, yanıtlar ve hatalar tek sayfada. Örneklerde curl ve JSON kullanılır.

Başlarken

HTTPS üzerinden JSON. Bir müşterinin anahtarı değiştiğinde müşteri başına bir çağrı gönderin. Her çağrı güvenle tekrarlanabilir.

Temel URLhttps://api.anuto.app/v1

Uç noktalar

Uç nokta Anlamı
POST/provider/clientsBir müşteriyi etkinleştirme veya güncelleme
GET/provider/clients/{externalId}Bir müşterinin durumu
DELETE/provider/clients/{externalId}Bir müşteriyi devre dışı bırakma ve ilanlarını geri çekme
POST/provider/clients/{externalId}/changesAnuto'ya müşterinin stoğunun değiştiğini bildirme
GET/provider/meAnahtarı kontrol etme: sağlayıcı adı, formatlar ve durum

Tekrar denemek güvenlidir

Aynı externalId ile yapılan çağrılar o müşteriyi günceller. Asla kopya oluşturmaz, bu yüzden zaman aşımından sonra tekrar deneyebilirsiniz.

Kimlik doğrulama

Her istekte anahtarınızı Authorization başlığında gönderin. Anahtarlar anp_ ile başlar, yalnızca bir kez gösterilir ve API anahtarları sayfasında yenilenebilir.

Authorization: Bearer anp_…

Bir müşteriyi etkinleştirme veya güncelleme

POST/provider/clients

Müşterinin anahtarı açıldığında bilgilerini gönderin. Aynı externalId ile tekrar çağırmak o müşteriyi günceller.

curl -X POST https://api.anuto.app/v1/provider/clients \
  -H "Authorization: Bearer $ANUTO_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "externalId": "12345",
    "name": "Casa Sol Real Estate",
    "email": "[email protected]",
    "phone": "+34 600 000 000",
    "website": "https://casasol.es",
    "country": "ES",
    "listingsCount": 85
  }'
Alan Zorunlu Anlamı
externalId Zorunlu Bu müşteri için sizin kimliğiniz (örneğin yazılımınızdaki hesap veya şirket kimliği). 1 ila 100 karakter.
name Zorunlu İşletme adı (en fazla 120 karakter).
email Zorunlu Müşterinin iletişim e-postası. Anuto'da yeni ise Anuto hesabını oluşturmak için kullanılır.
country Zorunlu İki harfli ISO ülke kodu, örneğin ES.
phone İsteğe bağlı İletişim telefonu (en fazla 40 karakter).
website İsteğe bağlı Müşterinin web sitesi, http veya https.
format İsteğe bağlı Yalnızca erişiminiz birden fazla entegrasyonu kapsıyorsa gereklidir.
connection İsteğe bağlı Entegrasyonunuz için bağlantı alanları, varsa. Hangileri olduğunu erişiminizi onayladığımızda bildiririz.
listingsCount İsteğe bağlı Müşterinin ilan sayısı, planlama için.
test İsteğe bağlı Yalnızca verileri doğrular ve bağlantıyı kontrol eder. Hiçbir şey oluşturulmaz.

Yanıt

Her çağrı müşterinin durumunu, ilan sayılarını ve planını döndürür.

{
  "externalId": "12345",
  "clientId": "Xw3kQ9mZr2LpT7vNa4Bc",
  "status": "active",
  "shopUrl": "https://es.anuto.app/@casa-sol",
  "listings": { "active": 10, "waiting": 0, "planWaiting": 75 },
  "plan": { "tier": "free", "maxActive": 10, "freeMaxActive": 10 },
  "upgradeUrl": "https://es.anuto.app/user/manage/plan",
  "lastSyncAt": "2026-10-08T09:30:00.000Z"
}

Bir müşterinin durumunu sorgulama

GET/provider/clients/{externalId}

Müşterinin mevcut durumunu, ilan sayılarını ve planını, etkinleştirme yanıtıyla aynı biçimde döndürür.

curl https://api.anuto.app/v1/provider/clients/12345 \
  -H "Authorization: Bearer $ANUTO_KEY"

Bir müşteriyi devre dışı bırakma

DELETE/provider/clients/{externalId}

Bir müşteriyi silmek onu kapatır ve ilanlarını Anuto'dan geri çeker.

curl -X DELETE https://api.anuto.app/v1/provider/clients/12345 \
  -H "Authorization: Bearer $ANUTO_KEY"

Değişiklikleri bildirme

POST/provider/clients/{externalId}/changes

Bir müşterinin stoğu değiştiğinde, yani bir ilan oluşturulduğunda, güncellendiğinde, satıldığında veya silindiğinde çağırın. Bu müşteriyi, birkaç saatte bir yapılan düzenli senkronizasyonu beklemek yerine dakikalar içinde yeniden senkronize ederiz. 5 dakika içindeki çağrılar birleştirilir; bu yüzden her değişiklikte çağırmak sorun değildir.

  • Gövde isteğe bağlıdır. Değişen en fazla 100 mülk veya ürün kimliğinizi itemIds ile belirtebilirsiniz.
  • Başarılı bir çağrı 202 döndürür. nextSyncAt, yeniden senkronizasyonun planlandığı saattir (UTC).
  • Etkin olmayan bir müşteri için yanıtta queued: false ve bir mesaj bulunur. Hiçbir şey kuyruğa alınmaz.
curl -X POST https://api.anuto.app/v1/provider/clients/12345/changes \
  -H "Authorization: Bearer $ANUTO_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "itemIds": ["123", "456"] }'
{
  "queued": true,
  "nextSyncAt": "2026-10-08T12:00:00Z"
}

Anahtarınızı kontrol edin

GET/provider/me

Sağlayıcınızın adını, erişiminizin kapsadığı biçimleri ve anahtarın durumunu döndürür. Yeni bir anahtarın çalıştığını doğrulamak için önce bunu çağırın.

curl https://api.anuto.app/v1/provider/me \
  -H "Authorization: Bearer $ANUTO_KEY"
{
  "providerId": "Xw3kQ9mZr2LpT7vNa4Bc",
  "name": "Your software company",
  "formats": ["…"],
  "status": "approved"
}

Test modu

Verileri doğrulamak ve bağlantıyı kontrol etmek için test alanını true yapın. Hiçbir şey oluşturulmaz; olacak durumu ve kontrol sonuçlarını alırsınız.

{
  "externalId": "12345",
  "name": "Casa Sol Real Estate",
  "email": "[email protected]",
  "country": "ES",
  "test": true
}

{
  "ok": true,
  "wouldBe": "active",
  "checks": { "connection": "ok", "owner": "new_account" }
}

Müşteri durumları

  • activeYayında ve senkronize.
  • pendingBağlantı henüz çalışmıyor, bu yüzden hiçbir şey yayınlanmıyor.
  • reviewBu yeni müşterinin e-postası zaten başka bir Anuto hesabına ait olduğu için Anuto inceliyor.
  • inactiveSiz kapattınız veya Anuto kaldırdı.

Hatalar

Başarısız çağrılar statusCode, code ve message içeren JSON döndürür. code değerine göre karar verin; message insanlar içindir.

{
  "statusCode": 404,
  "code": "PROVIDER_CLIENT_NOT_FOUND",
  "message": "No client with externalId 12345"
}
Kod HTTP Anlamı
PROVIDER_KEY_INVALID401Anahtar eksik, bozuk veya bilinmiyor.
PROVIDER_REVOKED403Sağlayıcı erişiniz Anuto tarafından iptal edildi.
PROVIDER_FORMAT_REQUIRED400Yazılımınızda birden fazla format var, bu yüzden istek gövdesinde format gerekir.
PROVIDER_FORMAT_NOT_ALLOWED400Format, onaylı formatlarınız arasında değil.
PROVIDER_CLIENT_NOT_FOUND404Sağlayıcınızda bu externalId ile bir müşteri yok.

İstek sınırları

Sınırı aşarsanız Retry-After başlığıyla birlikte 429 alırsınız. Bu kadar saniye bekleyip yeniden deneyin.

API veya erişiminizle ilgili sorular mı var? [email protected]