@harrasteblogi JUURI NYT
--:--

Tilaa uutiskirje

Saat tuoreimmat 10 uusinta artikkelia kerran viikossa sähköpostiisi.

Tilaa uutiskirje

WordPressin custom endpointit ilman raskaita lisäosiaCustom endpointit ovat tehokas tapa rakentaa API-rajapintoja, webhook-vastaanottimia, AJAX-korvaajia ja integraatioita WordPressiin ilman raskaita plugin-ratkaisuja. Moni kehittäjä turvautuu tarpeettoman suuriin lisäosiin yksinkertaisten endpointtien rakentamiseen, vaikka WordPressin core tarjoaa lähes kaiken tarvittavan valmiiksi.

Tiivistelmä
Mitä custom endpoint tarkoittaa

Endpoint on URL, joka palauttaa:...

Paras tapa: WordPress REST API

Moderni ratkaisu on lähes aina:...

1. Yksinkertainen endpoint

add_action('rest_api_init', function () { register_rest_route( 'myplugin/v1', '/status', [ 'methods' => 'GET', 'callback' => 'my_status_endpoint', ] ); }); 2. Callback-funktio function my_status_endpoint() { return [ 'status'...

2. Callback-funktio

function my_status_endpoint() { return [ 'status' => 'ok' ]; } Response:...

3. HTTP-metodit

Voit määrittää:...

4. Request-parametrien käsittely

function endpoint($request) { $email = $request->get_param('email'); } Saatavilla:...

5. Permission callback

Tärkeä turvallisuudessa....

6. Public endpointit

Jos endpoint on julkinen:...

8. Virheiden palautus

return new WP_Error( 'invalid_request', 'Missing parameter', ['status' => 400] ); 9. Route-versionointi Hyvä käytäntö:...

9. Route-versionointi

Hyvä käytäntö:...

10. Endpoint ilman REST APIa

Mahdollinen myös rewrite-ratkaisulla....

11. Query var

add_filter('query_vars', function($vars) { $vars[] = 'custom_api'; return $vars; }); 12. Template redirect endpoint add_action('template_redirect', function() { if (get_query_var('custom_api')) { wp_send_json([ 'success' => true ]); }...

12. Template redirect endpoint

add_action('template_redirect', function() { if (get_query_var('custom_api')) { wp_send_json([ 'success' => true ]); } }); Tämä on kevyt mutta REST API on yleensä parempi....

15. Nonce-suojaus

Frontend-requesteissa:...

16. Rate limiting

Suojaa endpointit abusea vastaan....

17. Cachettavat endpointit

GET-endpointit voidaan cachettaa:...

18. Background processing

Älä tee raskaita operaatioita endpointissa....

19. Webhook endpointit

REST API sopii hyvin:...

20. Performance optimointi

Optimoi endpointit:...

22. Yleisimmät virheet

Moderni WordPress API stack:...

23. Paras moderni endpoint-arkkitehtuuri

Moderni WordPress API stack:...

Yhteenveto

Custom endpointit voidaan rakentaa WordPressiin erittäin tehokkaasti ilman raskaita lisäosia käyttämällä REST APIa, kevyitä controller-rakenteita ja modernia request-käsittelyä....

Kevyt endpoint-arkkitehtuuri parantaa:

  • suorituskykyä
  • turvallisuutta
  • ylläpidettävyyttä
  • skaalautuvuutta

Samalla vältetään:

  • admin-ajax.php pullonkaulat
  • plugin-bloat
  • ylimääräinen memory usage
  • monimutkainen dependency stack

Mitä custom endpoint tarkoittaa

Endpoint on URL, joka palauttaa:

  • JSON-dataa
  • webhook-vastauksen
  • tiedoston
  • autentikointivastauksen
  • custom HTML:n

Esimerkki:

example.com/wp-json/myplugin/v1/orders

Tai:

example.com/api/export

Paras tapa: WordPress REST API

Moderni ratkaisu on lähes aina:

register_rest_route()

Hyödyt:

  • kevyt
  • core-yhteensopiva
  • turvallinen
  • helposti versionoitava
  • JSON-native

1. Yksinkertainen endpoint

add_action('rest_api_init', function () {

    register_rest_route(
        'myplugin/v1',
        '/status',
        [
            'methods'  => 'GET',
            'callback' => 'my_status_endpoint',
        ]
    );
});

2. Callback-funktio

function my_status_endpoint() {

    return [
        'status' => 'ok'
    ];
}

Response:

{
  "status": "ok"
}

3. HTTP-metodit

Voit määrittää:

GET
POST
PUT
PATCH
DELETE

Esimerkki:

'methods' => 'POST'

4. Request-parametrien käsittely

function endpoint($request) {

    $email = $request->get_param('email');
}

Saatavilla:

  • query parametrit
  • body data
  • headerit

5. Permission callback

Tärkeä turvallisuudessa.

'permission_callback' => function () {

    return current_user_can('manage_options');
}

Ilman tätä endpoint voi olla avoin kaikille.

6. Public endpointit

Jos endpoint on julkinen:

'permission_callback' => '__return_true'

Mutta validoi data aina.

7. JSON response oikein

Käytä:

return rest_ensure_response($data);

Tämä varmistaa oikean REST-response-rakenteen.

8. Virheiden palautus

return new WP_Error(
    'invalid_request',
    'Missing parameter',
    ['status' => 400]
);

9. Route-versionointi

Hyvä käytäntö:

myplugin/v1
myplugin/v2

Älä riko vanhoja endpointteja.

10. Endpoint ilman REST APIa

Mahdollinen myös rewrite-ratkaisulla.

add_rewrite_rule(
    '^api/test/?',
    'index.php?custom_api=1',
    'top'
);

11. Query var

add_filter('query_vars', function($vars) {

    $vars[] = 'custom_api';

    return $vars;
});

12. Template redirect endpoint

add_action('template_redirect', function() {

    if (get_query_var('custom_api')) {

        wp_send_json([
            'success' => true
        ]);
    }
});

Tämä on kevyt mutta REST API on yleensä parempi.

13. Miksi admin-ajax kannattaa välttää

admin-ajax.php:

  • lataa admin-bootstrapin
  • raskaampi
  • hitaampi korkeassa liikenteessä

REST API:

  • kevyempi
  • modernimpi
  • paremmin cachettava

14. Authentication vaihtoehdot

Voit käyttää:

  • cookie auth
  • nonce
  • JWT
  • Application Passwords
  • API keyt

15. Nonce-suojaus

Frontend-requesteissa:

wp_create_nonce('wp_rest');

JS:

headers: {
   'X-WP-Nonce': nonce
}

16. Rate limiting

Suojaa endpointit abusea vastaan.

Esimerkki:

$key = 'api_' . $_SERVER['REMOTE_ADDR'];

Tallennus:

  • transient
  • Redis
  • custom table

17. Cachettavat endpointit

GET-endpointit voidaan cachettaa:

CDN
↓
Edge cache
↓
REST API

Tämä vähentää serverikuormaa merkittävästi.

18. Background processing

Älä tee raskaita operaatioita endpointissa.

Huono:

API request
↓
Massive import

Parempi:

API request
↓
Queue job
↓
Background worker

19. Webhook endpointit

REST API sopii hyvin:

  • Stripe webhookeihin
  • GitHub webhookeihin
  • CRM-integratioihin

Tärkeää:

  • signature validation
  • logging
  • retry handling

20. Performance optimointi

Optimoi endpointit:

  • vältä raskaita WP_Queryjä
  • käytä object cachea
  • minimoi bootstrap
  • cachetaa GET-responseja
  • käytä batch processingia

21. Dependency injection endpointteihin

Hyvä arkkitehtuuri:

Route
↓
Controller
↓
Service
↓
Repository

Ei kaikkea callback-funktioon.

22. Yleisimmät virheet

  • admin-ajax käyttö kaikkeen
  • ei permission callbackia
  • raskaat queryt endpointissa
  • ei rate limitingiä
  • duplicate endpoint-logiikka
  • liian isot response payloadit
  • ei validointia

23. Paras moderni endpoint-arkkitehtuuri

Moderni WordPress API stack:

REST Route
↓
Middleware
↓
Controller
↓
Service Layer
↓
JSON Response

Yhteenveto

Custom endpointit voidaan rakentaa WordPressiin erittäin tehokkaasti ilman raskaita lisäosia käyttämällä REST APIa, kevyitä controller-rakenteita ja modernia request-käsittelyä.

Kun endpointit suunnitellaan suorituskyky ja turvallisuus edellä, WordPress pystyy toimimaan vakaana API-alustana myös vaativissa integraatioissa ja korkeassa liikenteessä.

🍪

🛡️ Evästeet

Moderni tietosuojakeskus ja evästehallinta.
harrasteblogi.online · Versio 60000.0.0

Mitä evästeet ovat?

Evästeiden yleinen määritelmä

Evästeet ovat pieniä tekstitiedostoja, jotka verkkosivustot tallentavat käyttäjän laitteelle, kuten tietokoneelle, tabletille tai älypuhelimelle, verkkoselaimen välityksellä. Niiden tarkoituksena on helpottaa verkkosivustojen käyttöä, parantaa käyttäjäkokemusta sekä mahdollistaa sivuston tekninen toiminta. Evästeet ovat olennainen osa nykyaikaisia verkkopalveluja, sillä niiden avulla sivustot voivat tunnistaa käyttäjän ja muistaa hänen asetuksensa eri vierailukertojen välillä.

Miten evästeet toimivat?

Kun käyttäjä vierailee verkkosivustolla ensimmäistä kertaa, sivusto voi tallentaa selaimeen evästeen. Seuraavilla käyntikerroilla selain lähettää evästeen takaisin sivustolle, jolloin sivusto tunnistaa käyttäjän tai hänen aiemmat valintansa. Tämän ansiosta esimerkiksi kirjautumistiedot, kieliasetukset tai ostoskorin sisältö voidaan säilyttää käyttäjän seuraavaa vierailua varten.

Välttämättömät evästeet

Välttämättömät evästeet ovat tarpeen verkkosivuston perustoimintojen mahdollistamiseksi. Niiden avulla käyttäjä voi esimerkiksi kirjautua palveluun, käyttää suojattuja alueita tai lisätä tuotteita ostoskoriin. Ilman näitä evästeitä verkkosivusto ei välttämättä toimi tarkoitetulla tavalla.

Toiminnalliset evästeet

Toiminnalliset evästeet parantavat käyttökokemusta muistamalla käyttäjän valintoja ja asetuksia. Tällaisia voivat olla esimerkiksi kielivalinnat, sijaintiin liittyvät asetukset tai muut henkilökohtaiset mieltymykset. Näiden evästeiden avulla verkkosivusto voi tarjota käyttäjälle yksilöllisemmän ja sujuvamman käyttökokemuksen.

Analytiikkaevästeet

Analytiikkaevästeiden avulla kerätään tietoa verkkosivuston käytöstä. Ne auttavat sivuston ylläpitäjää ymmärtämään, miten kävijät käyttävät palvelua, mitkä sivut ovat suosituimpia ja miten sivuston toimivuutta voidaan kehittää. Kerätty tieto on yleensä koottua eikä sitä käytetä yksittäisten käyttäjien tunnistamiseen.

Markkinointi- ja kohdennusevästeet

Markkinointievästeitä käytetään käyttäjän kiinnostuksen kohteisiin perustuvan mainonnan näyttämiseen. Ne voivat seurata käyttäjän toimintaa eri verkkosivustoilla ja auttaa tarjoamaan sisältöä sekä mainoksia, jotka vastaavat paremmin käyttäjän tarpeita ja kiinnostuksen kohteita. Näitä evästeitä voivat asettaa myös kolmannet osapuolet, kuten mainosverkostot tai sosiaalisen median palvelut.

Evästeiden hallinta

Käyttäjällä on mahdollisuus hallita evästeiden käyttöä. Useimmat verkkoselaimet tarjoavat asetuksia, joiden avulla evästeitä voidaan hyväksyä, rajoittaa tai poistaa kokonaan. Lisäksi monet verkkosivustot tarjoavat evästeasetuksia, joiden kautta käyttäjä voi valita, mitä evästekategorioita hän haluaa hyväksyä.

Yksityisyys ja tietosuoja

Evästeiden käytössä on tärkeää huomioida käyttäjän yksityisyys ja henkilötietojen suoja. Verkkosivustojen tulee kertoa avoimesti evästeiden käytöstä sekä tarvittaessa pyytää käyttäjän suostumus ennen muiden kuin välttämättömien evästeiden tallentamista. Näin varmistetaan läpinäkyvä ja luotettava verkkopalvelun käyttö.

Välttämättömät evästeet ovat verkkosivuston toiminnan kannalta olennaisia evästeitä, jotka mahdollistavat sivuston perustoiminnot ja turvallisen käytön. Ilman näitä evästeitä verkkosivusto ei pysty toimimaan asianmukaisesti, eikä käyttäjä välttämättä voi hyödyntää kaikkia palvelun ominaisuuksia.

Näitä evästeitä käytetään esimerkiksi käyttäjän istunnon ylläpitämiseen, kirjautumisen hallintaan, tietoturvan varmistamiseen sekä lomakkeiden ja ostoskorien toiminnan mahdollistamiseen. Välttämättömät evästeet auttavat myös tunnistamaan käyttäjän saman istunnon aikana, jotta sivuston eri osat toimivat saumattomasti.

Koska välttämättömät evästeet ovat tarpeellisia verkkosivuston teknisen toiminnan kannalta, niitä ei yleensä voida poistaa käytöstä verkkosivuston evästeasetuksista. Käyttäjä voi kuitenkin estää evästeiden tallentamisen selaimen asetuksista, mutta tämä saattaa heikentää sivuston toimivuutta tai estää joidenkin palveluiden käytön kokonaan.

Välttämättömiä evästeitä ei käytetä markkinointitarkoituksiin, eikä niiden avulla yleensä seurata käyttäjän toimintaa eri verkkosivustojen välillä. Niiden ensisijaisena tarkoituksena on varmistaa verkkopalvelun turvallinen, luotettava ja tehokas toiminta käyttäjän hyväksi.

Analytiikkaevästeitä käytetään verkkosivuston käytön mittaamiseen ja analysointiin. Niiden avulla kerätään tietoa esimerkiksi kävijämääristä, suosituimmista sivuista, sivustolla vietetystä ajasta sekä siitä, miten käyttäjät liikkuvat verkkosivuston eri osioiden välillä. Kerättyjen tietojen avulla verkkosivuston ylläpitäjä voi arvioida palvelun toimivuutta ja kehittää sitä vastaamaan paremmin käyttäjien tarpeita.

Analytiikkaevästeiden keräämä tieto on yleensä koottua ja anonymisoitua, eikä sitä käytetä yksittäisen käyttäjän tunnistamiseen ilman erillistä perustetta. Tietojen avulla voidaan esimerkiksi tunnistaa teknisiä ongelmia, parantaa sivuston käytettävyyttä sekä seurata uusien ominaisuuksien toimivuutta.

Verkkosivustot voivat käyttää analytiikkapalveluita, kuten Google Analyticsia tai vastaavia työkaluja, jotka hyödyntävät evästeitä kävijätilastojen muodostamiseen. Näiden palveluiden avulla saadaan arvokasta tietoa sivuston suorituskyvystä ja käyttäjäkokemuksesta.

Analytiikkaevästeiden käyttö perustuu yleensä käyttäjän antamaan suostumukseen. Käyttäjä voi hyväksyä tai hylätä analytiikkaevästeet evästeasetuksissa sekä muuttaa valintojaan myöhemmin. Analytiikkaevästeiden estäminen ei yleensä vaikuta verkkosivuston perustoimintoihin, mutta se voi rajoittaa sivuston ylläpitäjän mahdollisuuksia kehittää palvelua käyttäjien tarpeiden mukaisesti.

Markkinointievästeitä käytetään käyttäjälle näytettävän sisällön ja mainonnan kohdentamiseen. Näiden evästeiden avulla voidaan kerätä tietoa käyttäjän kiinnostuksen kohteista, verkkosivuston käytöstä sekä vuorovaikutuksesta eri verkkopalveluiden kanssa. Tavoitteena on tarjota käyttäjälle mahdollisimman relevantteja mainoksia ja markkinointiviestejä.

Markkinointievästeet voivat seurata käyttäjän toimintaa useilla verkkosivustoilla ja luoda tietoa käyttäjän kiinnostuksen kohteista. Tämän tiedon perusteella käyttäjälle voidaan näyttää hänen oletettuihin mieltymyksiinsä perustuvaa mainontaa esimerkiksi verkkosivustoilla, sosiaalisen median palveluissa tai hakukoneissa.

Näitä evästeitä voivat asettaa sekä verkkosivuston omistaja että kolmannet osapuolet, kuten mainosverkostot, analytiikkapalvelut tai sosiaalisen median alustat. Kolmannen osapuolen evästeiden avulla voidaan myös mitata markkinointikampanjoiden tehokkuutta ja seurata, kuinka käyttäjät reagoivat mainoksiin.

Markkinointievästeiden käyttö edellyttää yleensä käyttäjän nimenomaista suostumusta. Käyttäjä voi hyväksyä tai hylätä markkinointievästeet evästeasetusten kautta sekä muuttaa valintojaan milloin tahansa. Markkinointievästeiden estäminen ei vaikuta verkkosivuston perustoimintoihin, mutta se voi vähentää käyttäjälle näytettävän mainonnan yksilöllisyyttä ja osuvuutta.

Verkkosivusto sitoutuu käsittelemään evästeiden avulla kerättyjä tietoja voimassa olevan tietosuojalainsäädännön mukaisesti sekä huolehtimaan siitä, että käyttäjälle annetaan riittävät tiedot evästeiden käytöstä ja niiden tarkoituksista.

Verkkosivuston evästeiden käyttöön sovelletaan voimassa olevaa tietosuoja- ja yksityisyydensuojalainsäädäntöä. Tärkeimpiä säädöksiä ovat Euroopan unionin yleinen tietosuoja-asetus (GDPR), sähköisen viestinnän tietosuojasääntelyyn perustuva ePrivacy-lainsäädäntö sekä Kalifornian kuluttajansuojalaki (CCPA) ja sen täydennykset.

GDPR (General Data Protection Regulation)

GDPR on Euroopan unionin tietosuoja-asetus, joka säätelee henkilötietojen käsittelyä. Mikäli evästeiden avulla kerätty tieto voidaan yhdistää tunnistettuun tai tunnistettavissa olevaan henkilöön, sitä käsitellään henkilötietona. GDPR edellyttää, että henkilötietojen käsittelylle on laillinen peruste, kuten käyttäjän suostumus tai oikeutettu etu. Käyttäjällä on myös oikeus saada tietoa henkilötietojensa käsittelystä sekä käyttää tietosuoja-asetuksen mukaisia oikeuksiaan.

ePrivacy-lainsäädäntö

ePrivacy-sääntely täydentää GDPR:ää ja koskee erityisesti sähköisen viestinnän luottamuksellisuutta sekä evästeiden käyttöä. Sen mukaan verkkosivuston on pääsääntöisesti pyydettävä käyttäjän suostumus ennen muiden kuin välttämättömien evästeiden tallentamista käyttäjän laitteelle. Käyttäjälle on annettava selkeät tiedot evästeiden käyttötarkoituksista sekä mahdollisuus hyväksyä tai hylätä evästeet.

CCPA (California Consumer Privacy Act)

CCPA on Kalifornian osavaltiossa sovellettava tietosuojalaki, joka antaa kuluttajille oikeuden tietää, mitä henkilötietoja heistä kerätään, miten tietoja käytetään ja luovutetaan sekä mahdollisuuden vastustaa henkilötietojen myyntiä tai jakamista tietyissä tilanteissa. CCPA:n piirissä olevien organisaatioiden tulee tarjota käyttäjille läpinäkyvää tietoa tietojen käsittelystä ja mahdollistaa lain mukaisten oikeuksien käyttäminen.

Käyttäjän oikeudet

Sovellettavan lainsäädännön mukaisesti käyttäjällä voi olla oikeus:

  • saada tietoa henkilötietojen käsittelystä;
  • tarkastaa itseään koskevat tiedot;
  • pyytää virheellisten tietojen oikaisemista;
  • pyytää henkilötietojen poistamista tietyissä tilanteissa;
  • rajoittaa henkilötietojen käsittelyä;
  • vastustaa henkilötietojen käsittelyä;
  • peruuttaa aiemmin antamansa suostumus milloin tahansa; sekä
  • tehdä valitus toimivaltaiselle valvontaviranomaiselle.

Verkkosivusto pyrkii varmistamaan, että evästeiden käyttö ja henkilötietojen käsittely tapahtuvat läpinäkyvästi, turvallisesti ja voimassa olevan lainsäädännön mukaisesti.