Allmine API
Users and Discovery

Users search invitable

~5 dkBackendMobil / WebKararlı

Davet edilebilir kullanıcı arama filtresi

Kullanıcı Davet Arama Servisi

Temel Bilgiler

  • İsim: Users - Search Invitable
  • Açıklama: Davet edilebilir kullanıcıları aramak veya mevcut takip listenizden hızlı öneriler almak için kullanılır.
  • URL: /users/search-invitable
  • Metot: GET
  • Kimlik Doğrulama: Bearer Token (JWT) zorunlu.
  • Etiketler: users

İstek

AlanTipZorunluAçıklama
Authorizationstring✔️Bearer <JWT> formatında erişim tokenı.

Sorgu Parametreleri

ParametreTipZorunluVarsayılanAçıklama
querystring-Kullanıcı adı, ad veya soyad üzerinden arama yapar. Boş bırakılırsa davet edilebilir takip listenizden en güncel 10 kişi döner.

İş Kuralları

  • query gönderilmezse, kimliği doğrulanmış kullanıcının FollowStatus.ACCEPTED durumundaki takip ettikleri alınır ve en fazla 10 kayıt döner. Hiç kayıt yoksa boş liste döner.
  • query gönderildiğinde MongoDB Atlas Search üzerinde username, name ve surname alanlarında fuzzy autocomplete araması yapılır. Sonuçlar en fazla 20 kayıtla sınırlandırılır.
  • Kimliği doğrulanmış kullanıcının kimliği geçersiz ise (örn. JWT içindeki _id alanı bozuksa) ve query parametresi yoksa boş liste döner.

Cevaplar

200 - Başarılı

[
  {
    "_id": "64d15f9e2e6c8f4d5a123456",
    "username": "johndoe",
    "name": "John",
    "surname": "Doe",
    "profilePhoto": {
      "_id": "64d1677b2e6c8f4d5a654321",
      "url": "https://cdn.allmine.com/media/64d1677b2e6c8f4d5a654321.jpg",
      "variants": {
        "thumbnail": "https://cdn.allmine.com/media/64d1677b2e6c8f4d5a654321-thumb.jpg"
      },
      "mimeType": "image/jpeg"
    }
  }
]

401 - Yetkisiz

{
  "statusCode": 401,
  "message": "Unauthorized"
}

500 - Sunucu Hatası

{
  "statusCode": 500,
  "message": "Internal server error"
}

Örnek İstek

GET /users/search-invitable?query=john HTTP/1.1
Host: api.allmine.com
Authorization: Bearer <JWT>

Notlar

  • Dönen liste UserSummaryDto şemasına uyar ve her kayıt kullanıcının profil fotoğrafı bilgilerini içerebilir.
  • Sonuçlar davet edilebilir kullanıcıların güncel durumuna göre gerçek zamanlı olarak hazırlanır.

On this page