API Key Yönetimi

Markdown olarak görüntüle

API Key yönetim uç noktaları yalnızca JWT kimlik doğrulamasını kabul eder.

Yarat API Key

1POST /v1/private/user/api-key/create
2Authorization: Bearer YOUR_ACCESS_TOKEN
3Content-Type: application/json

İstek parametreleri:

ParametreTipGerekliTanım
labelstringEvetAPI Key etiketi, uzunluğu 1 - 64
permissionsintHayırİzin bitmaskesi, varsayılan 1, aralık 1 - 7
ipWhitelistString[]HayırIP beyaz liste, 20’ye kadar giriş. Eğer hariç tutulursa, kaynak IP sınırsızdır

Örnek istemek:

$curl -X POST https://api.6mm.com/v1/private/user/api-key/create \
> -H "Content-Type: application/json" \
> -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
> -d '{
> "label": "external-service-prod",
> "permissions": 3,
> "ipWhitelist": ["203.0.113.10"]
> }'

Yanıt örneği:

1{
2 "code": 0,
3 "message": "success",
4 "data": {
5 "apiKey": "fx_xxxxxxxxxxxxxxxxxxxxxxxx",
6 "apiSecret": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
7 },
8 "requestId": "req-api-key"
9}

apiSecret API Key oluşturulduğunda sadece bir kez geri döner. Hemen gizli bir yönetim sisteminde depolayın. Bunu kaynak kod depolarına veya loglara yazmayın.

Her kullanıcı 30 API Anahtar oluşturabilir.

Liste API Anahtarlar

1GET /v1/private/user/api-key/list
2Authorization: Bearer YOUR_ACCESS_TOKEN

Yanıt alanları:

SahaTipTanım
list[].idstringAPI Key Kimliği
list[].labelstringPlak Şirketi
list[].apiKeystringKamu API Key tanımlayıcısı
list[].permissionsintPermission bitmask
list[].ipWhitelistString[]IP beyaz listesi
list[].statusintDurum: 1 etkin, 0 devre dışı bırakıldı
list[].lastUsedAtint64Son kullanım zamanı
list[].createdAtint64Yaratım zamanı

Güncelleme API Key

1PUT /v1/private/user/api-key/update
2Authorization: Bearer YOUR_ACCESS_TOKEN
3Content-Type: application/json

İstek parametreleri:

ParametreTipGerekliTanım
idstringEvetAPI Key Kimliği
labelstringHayırYeni plak şirketi
permissionsintHayırYeni izin bitmaskesi
ipWhitelistString[]HayırYeni IP beyaz listesi
statusintHayır1 etkinleştirildi, 0 devre dışı bırakıldı

Sil API Key

1POST /v1/private/user/api-key/delete
2Authorization: Bearer YOUR_ACCESS_TOKEN
3Content-Type: application/json

Talep bedeni:

1{ "id": "1001" }

Tüm API Anahtarlarını Sil

1POST /v1/private/user/api-key/delete-all
2Authorization: Bearer YOUR_ACCESS_TOKEN
3Content-Type: application/json

Yanıt alanları:

SahaTipTanım
deletedint64Silinen API Anahtar Sayısı