Kimlik doğrulama

API anahtarları, yetkiler ve IP izin listeleri.

Her /v1 isteğinde API anahtarınızı bearer token olarak gönderin.

Bash

curl https://runner.cargoduo.com/v1/balance \
  -H "Authorization: Bearer $CARGODUO_API_KEY"

API anahtarları

Anahtar	Ayrıntı
Biçim	`cd_live_` + 40 karakter
Oluşturan	Organizasyon sahibi, geliştirici konsolunda
Gösterim	Yalnızca bir kez, oluşturulurken. Sadece hash'i saklanır
Organizasyon başına	En fazla 20 etkin anahtar
İsteğe bağlı	Son kullanma tarihi, IP izin listesi (IP'ler ya da CIDR aralıkları)
Yenileme	Yeni gizli anahtar, aynı ayarlar. Eskisi anında geçersiz olur

Anahtarları sunucunuzda tutun. Hiçbir zaman bir tarayıcıya ya da mobil uygulamaya gömmeyin.

Yetki	Endpoint'ler
`pack:write`	`POST /v1/pack`, `POST /v1/estimate`, `DELETE /v1/jobs/{id}`, `POST /v1/projects/{id}/pack`
`jobs:read`	`GET /v1/jobs`, `GET /v1/jobs/{id}`, `GET /v1/jobs/{id}/result`
`account:read`	`GET /v1/limits`, `GET /v1/balance`, `GET /v1/usage`
`resources:read`	`GET /v1/projects`, `GET /v1/projects/{id}`, `GET /v1/vehicles`, `GET /v1/vehicles/{id}`, `GET /v1/templates`, `GET /v1/templates/{id}`
`resources:write`	`POST /v1/projects`, `PATCH /v1/projects/{id}`, `DELETE /v1/projects/{id}`, `POST /v1/projects/{id}/pack`, `POST /v1/vehicles`, `PATCH /v1/vehicles/{id}`, `DELETE /v1/vehicles/{id}`, `POST /v1/templates`, `PATCH /v1/templates/{id}`, `DELETE /v1/templates/{id}`

Yeni anahtarlar tüm yetkilere sahiptir. POST /v1/projects/{id}/pack için hem pack:write hem de resources:write gerekir.

Durum	Kod	Anlamı
401	`unauthorized`	API anahtarı eksik, hatalı biçimde ya da tanınmıyor.
401	`key_revoked`	Anahtar iptal edildi.
401	`key_expired`	Anahtarın geçerlilik süresi doldu.
403	`ip_not_allowed`	İsteği gönderen IP, anahtarın izin listesinde değil.
403	`subscription_inactive`	Organizasyonun API'yi içeren etkin bir aboneliği yok.
403	`account_inactive`	Organizasyon askıya alınmış ya da hesabı etkin olan bir organizasyon sahibi yok.
403	`scope_missing`	Anahtarda bu endpoint'in gerektirdiği bir yetki eksik.
429	`rate_limited`	Geçerli dakika, saat ya da gün içinde çok fazla istek gönderildi (anahtar ya da organizasyon başına) veya IP adresinizden gelen başarısız kimlik doğrulama denemeleri dakikada 60 sınırını aştı.