İçeriğe geç

Hızlı başlangıç

Bir API anahtarı oluşturun, ardından birkaç dakikada ilk taslak alacağınızı oluşturup okuyun.

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.

Bu rehber API üzerinden bir taslak alacak oluşturur ve onu geri okur. Müşterinize hiçbir şey gönderilmez.

1. API anahtarı oluşturun

Uygulamada Ayarlar → API anahtarları bölümünü açın ve receivables:read ile receivables:write kapsamlarına sahip bir anahtar oluşturun.

  • Anahtarları yalnızca şirket sahipleri ve yöneticileri yönetebilir.
  • Hesabınızın doğrulanmış bir e-postası ve iki adımlı doğrulaması olmalıdır; anahtarları yönetmeden önce parolanızı onaylarsınız.
  • Anahtar yalnızca bir kez gösterilir. Bir gizli anahtar deposuna kopyalayın; RemindCash yalnızca özetini (hash) saklar.
  • Anahtarların süresi 30 gün sonra dolar. Yenileme için Kimlik doğrulama sayfasına bakın.

2. Anahtarı kodunuzun dışında tutun

BASH
export REMINDCASH_API_KEY="<api-anahtariniz>"

3. Taslak alacak oluşturun

Yeniden denenen bir isteğin asla kopya oluşturmaması için her yazma işlemi bir Idempotency-Key başlığı gerektirir.

BASH
curl https://api.remindcash.com/v1/receivables \
  --request POST \
  --header "Authorization: Bearer $REMINDCASH_API_KEY" \
  --header "Idempotency-Key: create-inv-1042-0001" \
  --header "Content-Type: application/json" \
  --data '{
    "customer": { "display_name": "Studio North", "email": "billing@studionorth.example" },
    "amount": "1250.00",
    "currency": "USD",
    "due_date": "2026-10-15",
    "external_reference": "INV-1042",
    "description": "Website redesign"
  }'

Yanıt 201 Created olur:

JSON
{
    "data": {
        "id": 1,
        "customer_id": 1,
        "amount_minor": 125000,
        "paid_minor": 0,
        "currency": "USD",
        "due_date": "2026-10-15",
        "status": "draft",
        "external_reference": "INV-1042",
        "description": "Website redesign",
        "version": "4e6fea39ae2fab8ccb843657f081d276513739a71787c060a007b65e3acbbbc1"
    }
}

4. Geri okuyun

BASH
curl https://api.remindcash.com/v1/receivables/1 \
  --header "Authorization: Bearer $REMINDCASH_API_KEY"

5. Uygulamada etkinleştirin

Alacağı uygulamada açın, müşterinin iletişim bilgilerini ve iznini onaylayın, hatırlatma planını gözden geçirin ve etkinleştirin. Etkinleştirme API üzerinden yapılamaz.

Sonraki: Kavramlar.