API anahtarları ve OAuth istemcileri
Polylane'in programatik erişim için iki kimlik bilgisi türü vardır. API anahtarları betiklere, CI'ya ve başsız araçlara uyar: tek anahtar, tek çalışma alanı, sabit bir kapsam kümesi. OAuth istemcileri kullanıcıların oturumunu açan ve onlar adına Polylane'i çağıran uygulamalara uyar; ikisi de aynı API'ye karşı kimlik doğrular.
API anahtarları
Konsolda Settings > API Keys'i aç ve Create an API key'e tıkla. Anahtarı adlandır (en az 4 karakter) ve kapsamlarını seç: form kendi üyeliğinin taşıdığı kapsamları önceden seçer ve taşımadığın bir kapsam isteği 403 ile başarısız olur. Anahtar bir kez gösterilir, sk_ ile başlar ve yeniden görüntülenemez, bu yüzden onu gizli anahtar yöneticine kopyala.
Anahtarı x-api-key başlığında gönder:
curl https://api.polylane.com/v1/scopes \
-H "x-api-key: sk_xxxxx"
İstekler tam izinlerine değil, anahtarın kapsamlarına karşı yetkilendirilir. Bir anahtarı aynı ayar sayfasından ya da /v1/api_keys/{workspaceId}/{id} adresine bir DELETE ile iptal et; anahtarı oluşturan kişi veya bir çalışma alanı yöneticisi silebilir.
Kapsamlar
Kapsamlar bir kaynağı bir eylemle eşler ve GET /v1/scopes her birini açıklamasıyla listeler. Bu dokümanlarda en sık karşılaşacağın kapsamlar şunlardır.
| Kapsam | Açıklama |
|---|---|
threads:read | Threadleri görüntüle. |
issues:write | Sorun kontrollerini onayla, çöz veya yeniden çalıştır. |
cloud_infra:read | Bulut altyapısı düğümlerini ve kenarlarını görüntüle. |
autofixes:write | Otomatik düzeltme yaşam döngüsü durumunu kaydet ve güncelle. |
agent_tools:read | MCP gibi dış istemcilerden salt okunur ajan araçlarını keşfet ve çalıştır. |
agent_tools:write | Dış istemcilerden, güvenlik incelemesine tabi olarak, yazma yetenekli ajan araçlarını çalıştır. |
oauth_clients:write | OAuth istemcileri oluştur ve yönet. |
analytics:read | Çalışma alanı etkinliğini, popüler içeriği ve kullanım istatistiklerini görüntüle. |
OAuth istemcileri
Bir OAuth istemcisi, kullanıcıların oturumunu açabilmesi ve her kullanıcının onayladığı kapsamlarla Polylane'i çağırabilmesi için kaydettiğin bir uygulamadır; istemcileri yönetmek oauth_clients:write gerektirir. Settings > OAuth Clients'ı aç ve New OAuth client'a tıkla: ad ve iletişim e-postası onay ekranında görünür, yönlendirme URI'lerini ve istemcinin isteyebileceği kapsamları sen eklersin; açıklama, web sitesi ve logo isteğe bağlıdır. Oluşturma, oauth_client_ ile başlayan bir istemci kimliği ve bir kez gösterilen bir istemci gizli anahtarı döndürür; gizli anahtarı kaybedersen istemcinin sayfasından Rotate ile yenile; önceki gizli anahtar hemen çalışmayı bırakır.
Yetkilendirme akışı
Polylane, PKCE'li (S256) OAuth 2.0 yetkilendirme kodu akışını uygular.
Kullanıcıyı onay sayfasına gönder
https://console.polylane.com/oauth/<client-id>
?client_id=<client-id>
&redirect_uri=https://example.com/callback
&scope=threads:read%20issues:read
&code_challenge=<challenge>
&code_challenge_method=S256
&state=<random-state>
Yönlendirme URI'si kaydettiğin biriyle tam olarak eşleşmeli ve istenen her kapsam istemciye verilmiş bir kapsam olmalıdır.
Kodu tokenlarla değiştir
Kullanıcı onayladıktan sonra Polylane geri çağrına bir code ile yönlendirir. Onu arka ucunda değiştir:
curl -X POST https://api.polylane.com/v1/oauth/token \
-H "Content-Type: application/json" \
-d '{"grant_type": "authorization_code", "code": "<code>",
"redirect_uri": "https://example.com/callback",
"client_id": "<client-id>", "client_secret": "<client-secret>",
"code_verifier": "<verifier>"}'
Yanıt, bir saat sonra süresi dolan bir access_token ve bir refresh_token taşır.
API'yi kullanıcı olarak çağır
curl https://api.polylane.com/v1/scopes \
-H "Authorization: Bearer <access-token>"
Erişim tokenının süresi dolduğunda yenile
Aynı token uç noktasına grant_type refresh_token gönder. Yenileme tokenları tek kullanımlıktır: her yenileme bir yedek döndürür.
Her uç nokta URL'si dahil sunucu meta verileri https://api.polylane.com/v1/.well-known/oauth-authorization-server adresinde yayımlanır ve sağlayıcı ayrıca /v1/oauth/userinfo ve /v1/oauth/introspect uç noktalarını sunar. Uygulamanın tuttuğu bir tokenı, tokenı ve istemci kimlik bilgilerini taşıyan, token_type_hint değeri access_token veya refresh_token olan ya da ikisini de denemek için atlanan bir POST ile /v1/oauth/revoke adresinden iptal et. Bir istemciyi sayfasından silmek yeni yetkilendirmeler başlatmasını durdurur.
Kodlama ajanları
Bir kodlama ajanı bağlamak için OAuth istemcisine ihtiyacın yok. https://mcp.polylane.com/mcp adresindeki barındırılan MCP sunucusu dinamik istemci kaydıyla kendi OAuth akışını çalıştırır ve bir API anahtarını da kabul eder; bkz. Platform MCP sunucusu.
İlgili
- Bir istemci kaydetmeden bir editör ajanı bağlamak için Platform MCP sunucusu.
- CLI'de tarayıcıyla, cihaz koduyla veya API anahtarıyla oturum açmak için CLI kimlik doğrulaması.
- Her uç nokta ve gerektirdiği kapsamlar için API referansı.