Sari la conținut

Chei API

Chei secrete și publicabile, medii, scope-uri și domenii.

DocumentațieAPI

Meniul documentațieiChei API

Fiecare cheie ține de un proiect și de un mediu. Le creezi și le revoci în Developers → API keys; crearea și revocarea cer rolul de admin și intră amândouă în jurnalul de audit.

Feluri de chei

FelPrefixUnde stăCe poate
Secretă, producțiemf_live_pe server sau la buildcitește conținutul (content:read), plus scope-urile adăugate
Secretă, dezvoltaremf_test_pe calculatorul tău, pe stagingimplicit content:read și content:preview
Publicabilămf_pk_live_, mf_pk_test_în sursa paginiitrimite date de analiză și răspunsuri la formulare de pe domeniile ei

Cheia secretă întreagă se arată o singură dată, la creare. Manifolio păstrează doar prefixul și un hash cu cheie, așa că o cheie pierdută nu se poate recupera: o revoci și creezi alta.

Scope-uri

ScopePermite
content:readDelivery API
content:previewPreview API, inclusiv ciornele
content:writerezervat pentru scrierea conținutului prin API
analytics:readrezervat pentru citirea analizei prin API

O cerere fără scope-ul potrivit primește 403 missing_scope.

Domeniile cheilor publicabile

O cheie publicabilă are o listă de domenii în loc de scope-uri, de exemplu aurora.coffee și *.aurora.coffee. Cererile de oriunde altundeva primesc 403 host_not_allowed. Cheile publicabile de dezvoltare acceptă și localhost și 127.0.0.1.

Revocarea

Revocarea are efect pe loc: cererile cu cheia primesc 401 key_revoked. Un proiect poate avea cel mult 50 de chei active.

Cheile, în siguranță

  • Ții cheile secrete în variabilele de mediu ale serverului sau în locul de secrete al găzduirii, niciodată în codul din browser sau în git.
  • Local folosești o cheie de dezvoltare, iar una de producție doar acolo unde se construiește sau se servește site-ul live.
  • Fila API logs arată fiecare cerere cu cheia, calea, starea și durata, așa că o cheie folosită unde nu trebuie se vede ușor.