Autentisering
- Authorization: ApiKey
- API-nyckeln skickas endast i HTTP-huvudet Authorization för POST /api/v1/auth/token. Lägg den inte i JSON, en URL eller frågeparametrar.
- Authorization: Bearer
- Använd den returnerade token för resursbegäranden och förnya den enligt expires_at. expires_in anges i sekunder.
Varför hämta en token först?
API-nyckeln används för att hämta en token. Den är giltig i 15 minuter och kan användas för flera anrop. Skicka bara token till resurser i headern Authorization: Bearer.
Vanliga anrop innehåller inte API-nyckeln. En läckt token ger tillgång som längst tills den löper ut. En stulen API-nyckel kan fortfarande göra det möjligt att hämta nya token.
Hur länge är en token giltig?
- expires_in
- 900 sekunder, alltså 15 minuter från utfärdandet. Anrop förlänger inte giltighetstiden.
- expires_at
- Utgångstid i UTC. Aktuella åtkomstbegränsningar kan blockera token tidigare.
När ska du hämta en ny token?
Återanvänd samma token för flera anrop och hämta en ny före expires_at. Hämta inte en token inför varje åtgärd. Använd API-nyckeln för att hämta den nya token.
Åtkomst nekad och nya försök
- 401
- 401 betyder inte alltid att token har löpt ut. Om den har löpt ut, hämta en ny och upprepa läsningen högst en gång. Om tokenanropet ger 401, kontrollera nyckeln och stoppa automatiska försök.
- 403
- Vid 403 ska du kontrollera behörigheter, IP-begränsningar och abonnemang. En ny token återställer inte återkallad åtkomst.
IP-begränsningar
- En åtkomsttoken kringgår inte nyckelns aktuella behörigheter, butikens abonnemangsvillkor, återkallelser eller IP-begränsningar.
- Begränsa vid behov nyckeln till integrationens källadresser.
- Administratören kan redigera listan; högst 32 adresser accepteras.
Nyckelhantering
- Hantering av API-nycklar är skild från integrationens resursbehörigheter.
- Endast owner får ge grupper administrativa behörigheter att visa, skapa, redigera eller ta bort nycklar.
- En behörig gruppmedlem får bara utföra de åtgärder som gruppen har tilldelats.
Anropsgränser
Engine ≥ 4.143.0. Varje tokensvar innehåller data.rate_limits från butikens policy vid utfärdandet. Alla nycklar delar dessa budgetar; en ny token återställer dem inte. En planändring kan gälla innan token löper ut.
- read_per_minute
- Läsanrop per minut.
- write_per_minute
- Skrivanrop per minut; värdet ger inte skrivbehörighet.
- auth_per_minute
- Tokenanrop per minut, inklusive misslyckade autentiseringsförsök.