Questa API serve a fornire a Slevomat.cz un codice voucher dopo che un cliente ha pagato un ordine per un affare. Di solito, Slevomat.cz genera il proprio codice voucher, ma utilizzando questa API, il nostro partner commerciale può essere informato dell'ordine e generare il proprio codice voucher personalizzato per il cliente.
Tutte le richieste vengono eseguite tramite protocollo HTTPS (che richiede che il server del partner commerciale supporti HTTPS e disponga di un certificato valido) e tutti i dati devono essere formattati come JSON .
Registro delle modifiche
01. 03. 2017 – aggiunta sezione gestione richieste non valide
10. 02. 2017 – versione iniziale
Abilitazione dell'API
Tutte le richieste vengono eseguite dall'applicazione Slevomat.cz inviando una richiesta al server del partner. La richiesta conterràX-RequestToken Intestazione HTTP con una stringa segreta. Questa stringa deve essere verificata dal server del partner per garantire la sicurezza. Questa stringa segreta è nota solo a Slevomat.cz e al partner.
Per abilitare l'API, il partner deve chiedere a Slevomat.cz e fornire un URL in cui si troverà l'API, ad esempio:
https://example.com/slevomat-external-voucher-code/generate
Una volta che Slevomat.cz abilita l'API per il partner e fornisce al partner l'X-RequestToken valore, è solo in modalità di test, il che significa che nessun ordine reale eseguirà una richiesta per ottenere un codice voucher personalizzato. Ma consente al partner di sviluppare e testare l'API sul suo server con il fornitoX-RequestToken valore.
Dopo che l'API sul server del partner sarà sviluppata e testata, Slevomat.cz cambierà la modalità in ordini reali. Gli ordini per le offerte che hanno iniziato a vendere dopo il passaggio richiederanno all'API del partner codici voucher personalizzati.
Generazione del codice voucher
Quando un ordine per un affare viene pagato, Slevomat.cz invierà una richiesta POST al server del partner per generare un codice voucher e fornirà al partner alcune informazioni sull'ordine. Questa richiesta verrà inviata individualmente per ogni unità venduta.
La richiesta contiene il prefisso del codice voucher obbligatorio. Il codice voucher generato deve iniziare con questo prefisso .
Il corpo della richiesta apparirà così:
{ "uuid": "91987a73-095c-4b94-bd38-f6ffd4ab86a7", "deal": { "product_id": 123, "product_name": "Aktivní dovolená: 4 až 6 dní s all inclusive v Rakousku. 2 děti do 8,9 let zdarma!", "variant_id": 456, "variant_name": "1 osoba | 4 dny (3 noci) | Období So 13. 5. – So 24. 6. 2017, Ne 27. 8. – Ne 5. 11. 2017" }, "customer": { "email": "cu******@ex*****.com" }, "voucherCodePrefix": "LIN", "repeatReason": 1 }Il server dovrebbe rispondere con il codice di stato HTTP 200 e il corpo della risposta con il codice voucher generato deve apparire così:
{ "voucherCode": "LIN1234567890" }Il server deve rispondere entro 10 secondi , altrimenti la richiesta viene contrassegnata come non riuscita. Il codice voucher generato deve iniziare con un prefisso specificato e deve essere univoco. Ci sono altri motivi per cui potremmo non accettare il codice voucher generato.
Quando la richiesta non va a buon fine, viene ripetuta con la motivazione nelrepeatReason campo finché non avrà successo. Questo campo conterrà uno dei seguenti valori:
| Ripeti il motivo | Descrizione |
|---|---|
| 1 | Primo tentativo. |
| 2 | La connessione al server non è riuscita. Ciò può significare che il certificato HTTPS non è valido o che la rete era inattiva. |
| 3 | Il server non ha risposto in tempo. |
| 4 | Il server ha risposto con un codice di stato HTTP diverso da 200. |
| 5 | Il server ha risposto con HTTP 200, ma il corpo della risposta non conteneva JSON oppure il JSON non conteneva la chiave voucherCode. |
| 6 | Il codice voucher generato non conteneva il prefisso richiesto. |
| 7 | Il codice voucher generato contiene caratteri non validi. Gli unici caratteri validi sono:[a-zA-Z0-9-]+ . |
| 8 | Il codice voucher generato non era univoco. |
Il corpo della richiesta conterrà sempre lo stessouuid identificativo della precedente richiesta di generazione del codice voucher per lo stesso ordine del cliente.
Gestione delle richieste non valide
Quando si verifica una richiesta che non soddisfa i requisiti di sicurezza, ovvero contiene dati non validiX-RequestToken , il server deve rispondere con il codice HTTP 403 Forbidden.
Test di implementazione dell'API
Accedi come nostro partner per visualizzare lo stato della tua API e testare e verificare l'implementazione della tua API.