Kimlik doğrulama

Perquery API’sine gönderilen her istek bir API anahtarı içermelidir. API, anahtarla organizasyonunuzu bulur ve anahtarın neleri okuyabileceğini kontrol eder.

API anahtarını gönderin

Anahtarı Authorization başlığına yazın. Önce ApiKey kelimesini, sonra bir boşluk, sonra anahtarı yazın:

Authorization: ApiKey pq_xxxxxxxxxxxx_gizli_anahtariniz

curl https://perquery.ai/api/v1/sites \
  -H "Authorization: ApiKey $PERQUERY_API_KEY"

import os
import urllib.request

request = urllib.request.Request(
    "https://perquery.ai/api/v1/sites",
    headers={"Authorization": f"ApiKey {os.environ['PERQUERY_API_KEY']}"},
)
with urllib.request.urlopen(request) as response:
    print(response.read().decode())

const response = await fetch("https://perquery.ai/api/v1/sites", {
  headers: { Authorization: `ApiKey ${process.env.PERQUERY_API_KEY}` },
});
console.log(await response.json());

Anahtar biçimi

Bir anahtar, aralarında alt çizgi olan üç bölümden oluşur: pq_<önek>_<gizli>.

Bölüm	Açıklama
`pq`	Her Perquery anahtarının sabit başlangıcı.
Önek	12 karakter. API Anahtarları sayfasındaki Önek sütunu bu değeri gösterir. Anahtarı listede bu değerle bulursunuz.
Gizli bölüm	Anahtarın gizli bölümü. Perquery bu bölümü yalnızca bir kez, anahtarı oluşturduğunuzda gösterir.

Anahtarın üç bölümünü birlikte, tam olarak gönderin.

Bir anahtar oluşturun

API Anahtarları sayfasını açın

Perquery uygulamasında API Anahtarları sayfasını açın.

Anahtarı oluşturun

Anahtar oluştur’a tıklayın. Bir Ad girin. Gerekirse Son kullanma (isteğe bağlı) alanında bir tarih seçin. Oluştur’a tıklayın.

Anahtarı kopyalayın

Kopyala’ya tıklayın. Anahtarı güvenli bir yerde saklayın. Sonra Tamam’a tıklayın.

Tüm ayrıntılar için API anahtarları sayfasını okuyun.

Bir anahtar neleri okuyabilir

Bir anahtar salt okunurdur. Yalnızca GET isteklerini kabul eder.
Bir anahtar, onu oluşturan ekip üyesi adına çalışır. Yalnızca istek anında bu üyenin rollerinin izin verdiği verileri okur.
Oluşturucunun rolleri değişince anahtarın erişimi de değişir.
Organizasyonunuzda API erişimi add-on’u yoksa organizasyonun tüm anahtarları çalışmaz. API, missing-entitlement ile 403 yanıtı verir.

API bir anahtarı reddettiğinde

Durum	Slug	Neden
`401`	`unauthorized`	Başlıkta anahtar yok, anahtar doğru değil, anahtar iptal edildi veya anahtarın süresi doldu.
`403`	`forbidden`	İstek `GET` dışında bir yöntem kullanıyor veya API anahtarları bu endpoint’i kullanamaz.
`403`	`missing-entitlement`	Organizasyonunuzda API erişimi add-on’u yok.
`403`	`permission-denied`	Anahtarı oluşturan üyenin rolleri bu isteğe izin vermiyor.

Tüm hatalar için Hatalar ve limitler sayfasını okuyun.

Anahtarlarınızı güvende tutun

Bir anahtar organizasyonunuzun verilerine erişim verir. Bir anahtarı tarayıcı koduna, mobil uygulamaya veya herkese açık bir depoya koymayın.

Anahtarı yukarıdaki örneklerde olduğu gibi bir ortam değişkeninde veya bir gizli bilgi deposunda saklayın.
Her entegrasyona açık bir Ad ile ayrı bir anahtar verin. Böylece bir anahtarı iptal edip diğerlerini koruyabilirsiniz.
Yalnızca sınırlı bir süre gereken bir anahtar için son kullanma tarihi belirleyin.
Bir anahtar kaybolursa veya yanlışlıkla paylaşılırsa anahtarı hemen API Anahtarları sayfasında iptal edin. Sonra yeni bir anahtar oluşturun.

API

Endpoints

Kimlik doğrulama

API anahtarını gönderin

Anahtar biçimi

Bir anahtar oluşturun

Bir anahtar neleri okuyabilir

API bir anahtarı reddettiğinde

Anahtarlarınızı güvende tutun

İlgili sayfalar

​API anahtarını gönderin

​Anahtar biçimi

​Bir anahtar oluşturun

​Bir anahtar neleri okuyabilir

​API bir anahtarı reddettiğinde

​Anahtarlarınızı güvende tutun

​İlgili sayfalar

API anahtarını gönderin

Anahtar biçimi

Bir anahtar oluşturun

Bir anahtar neleri okuyabilir

API bir anahtarı reddettiğinde

Anahtarlarınızı güvende tutun

İlgili sayfalar