Kimlik doğrulama ve API anahtarları

Bearer API anahtarları, yetki kapsamları, anahtar sahibine ilişkin koşullar, süre dolumu, yenileme ve iptal.

Herkese açık API durumu

Burada anlatılan v1 API uygulanmış ve test edilmiştir, ancak api.remindcash.com henüz herkese açık değildir. Son kabul testlerinden sonra açılacak; o zamana kadar istekler 503 döner. Örneklerde yer tutucular kullanılır — gerçek bir anahtarı asla paylaşılan koda yapıştırmayın.

Bearer anahtarları

Anahtarınızı her isteğin Authorization başlığında gönderin:

HTTP

GET /v1/receivables HTTP/1.1
Host: api.remindcash.com
Authorization: Bearer <api-anahtariniz>
Accept: application/json

Geçerli anahtarı olmayan istekler 401 unauthenticated döndürür.

Yetki kapsamları

Her anahtar bir veya daha fazla kapsam taşır. Anahtarın kapsamı dışındaki bir istek 403 forbidden döndürür.

Kapsam	İzin verdiği
`receivables:read`	`GET /receivables`, `GET /receivables/{id}`, `GET /reminder-attempts`
`receivables:write`	`POST /receivables`, `PATCH /receivables/{id}`, ödemeler, duraklatma, sürdürme, iptal
`usage:read`	`GET /usage`
`payables:read`, `payables:write`	Ayrılmış. Henüz borç uç noktası yok.

Her entegrasyona yalnızca ihtiyaç duyduğu kapsamları verin.

Anahtarı kim kullanabilir

Bir anahtar, onu oluşturan kişi adına ve tek bir şirket içinde çalışır. Her istekte şunlar kontrol edilir:

anahtar sahibinin e-postası doğrulanmış ve iki adımlı doğrulaması onaylanmış olmalı,
anahtar sahibi hâlâ şirketin etkin bir üyesi olmalı,
şirketin kendisi etkin olmalı.

Kontrollerden biri başarısız olursa istek 403 forbidden döndürür. Bu nedenle bir ekip üyesini çıkardığınızda anahtarları hemen çalışmaz hale gelir.

Anahtar oluşturma, yenileme ve iptal

Anahtarlar uygulamada Ayarlar → API anahtarları bölümünden, iki adımlı doğrulaması olan şirket sahipleri ve yöneticileri tarafından yönetilir.

Yeni anahtar yalnızca bir kez gösterilir; RemindCash yalnızca özetini saklar.
Anahtarların süresi oluşturulduktan 30 gün sonra dolar.
Yenile, aynı ad ve kapsamlarla yeni bir anahtar üretir ve eskisini hemen siler. Yenilemeden önce gizli anahtar deponuzu güncelleyin.
İptal, anahtarı hemen siler.
Her kişi şirket başına en fazla 10 etkin anahtara sahip olabilir.

Anahtarları güvende tutun

Anahtarları kaynak kontrolünde veya ön yüz kodunda değil, bir gizli anahtar yöneticisinde ya da ortam değişkeninde saklayın.
Birini diğerlerini etkilemeden iptal edebilmek için farklı sistemlerde farklı anahtarlar kullanın.
Bir anahtarın sızmış olabileceğini düşünüyorsanız Ayarlar’dan hemen iptal edin.