REST API -yleiskatsaus
Alusta tarjoaa kattavan REST API -rajapinnan osoitteessa /api/, jonka avulla voit rakentaa omia verkkokauppoja, mobiilisovelluksia, kolmannen osapuolen integraatioita ja automaatioskriptejä.
Todennus
API käyttää Laravel Sanctum tokenipohjaiseen todennukseen.
Tokenin hankkiminen
POST /api/auth/login
Content-Type: application/json
{
"email": "[email protected]",
"password": "your-password"
}
Vastaus sisältää token kentän. Passaa se Bearer-tokenina myöhemmissä pyynnöissä:
Authorization: Bearer {your-token}
Vastauksen muoto
Kaikissa vastauksissa käytetään yhtenäistä rakennetta:
{
"status": true,
"message": "Products retrieved successfully",
"data": { ... }
}
Validointivirheet palauttavat HTTP 422 -koodin ja errors objektin.
Versiointi
API versioidaan URL-etuliitteen avulla. Nykyinen vakaa versio on /api/v1/. Rikkova muutoksia otetaan käyttöön vain uudessa versiossa.
Pyyntirajoitus
API-pyynnöille asetetaan pyyntirajoitus, jonka enimmäsmäärä on 60 pyyntöä minuutissa todennetun käyttäjän kohden. Rajan ylittäminen palauttaa HTTP 429 -vastauksen, jossa on Retry-After otsake.

