Pro přístup k API potřebujete chráněný klíč Vašeho Clipsan účtu.
Naleznete jej na stránce https://clipsan.com/cs/clipsan/securekey.
Kontaktem zakoupené produkty
Base URL:
https://clipsan.com/api/bought/view/
Vyžadované parametry
- key – Chráněný klíč Clipsan účtu
- id – ID kontaktu
- email – Email kontaktu
- pin – Rodné číslo (Buď ID nebo email nebo rodné číslo)
Příklady
Příklad volání
https://clipsan.com/api/bought/view/key/VASKLIC/id/123
https://clipsan.com/api/bought/view/?key=VASKLIC&id=123
Příklad odpovědi
{"result":"ok","lead":60616,"bought":{"1":{"id":1,"product":"1","added":1417388400,"deleted":null,"params":[]},"2":{"id":2,"product":"1","added":1414796400,"deleted":null,"params":{"price":"999","type":"full","check":"2014-01-01"}}}}
Příklad volání (neexistující kontakt)
https://clipsan.com/api/bought/view/key/VASKLIC/email/vaclav%40clipsana.com
https://clipsan.com/api/bought/view/?key=VASKLIC&email=vaclav%40clipsana.com
Příklad odpovědi
{"result":"error","error":"lead not found"}
Přidat novou zakoupenou položku
Base URL:
https://clipsan.com/api/bought/add/
Vyžadované parametry
- key – Chráněný klíč Clipsan účtu
- id – ID kontaktu
- email – Email kontaktu
- pin – Rodné číslo (Buď ID nebo email nebo rodné číslo)
- product – ID produktu (Produkty definujete v nastavení Clipsanu)
Vlastní parametry
K zakoupené položce můžete přidávat další parametry z přednastavených nebo začít používat vlastní. Jejich nastavení a úpravu provádíte přímo v nastavení Clipsanu. Kódy přednastavených parametrů jsou tyto: serialno,price,type,check,guarantee,note
Při použití parametru je nutné přidat před jeho název předložku „data_“. Výsledný parametr pro poslední kontakt je tedy data_price, parametr pro zemi data_type apod
Odpověď
{"result":"ok","id":"ID nové položky"}
Příklady
Příklad volání (základní přidání zakoupené jednotky)
https://clipsan.com/api/bought/add/key/VASKLIC/email/vaclav.krajnak%40ciwire.biz/product/5
https://clipsan.com/api/bought/add/?key=VASKLIC&email=vaclav.krajnak%40ciwire.biz&product=5
Příklad odpovědi
{"result":"ok","id":"1002"}
Příklad volání (přidání zakoupené položky s vlastními parametry)
https://clipsan.com/api/bought/add/key/VASKLIC/email/vaclav.krajnak%40ciwire.biz/product/5/data_price/999
https://clipsan.com/api/bought/add/?key=VASKLIC&email=vaclav.krajnak%40ciwire.biz&product=5&data_price=999
Příklad odpovědi
{"result":"ok","id":"1002"}
Příklad volání (neexistující kontakt)
https://clipsan.com/api/bought/add/key/VASKLIC/email/vaclav%40clipsana.com/product/X
https://clipsan.com/api/bought/add/?key=VASKLIC&email=vaclav%40clipsana.com&product=X
Příklad odpovědi
{"error":"bought item not found","result":"error"}
Příklad volání (neexistující produkt)
https://clipsan.com/api/bought/add/key/VASKLIC/email/vaclav%40clipsan.com/product/X
https://clipsan.com/api/bought/add/?key=VASKLIC&email=vaclav%40clipsan.com&product=X
Příklad odpovědi
{"error":"product not found","result":"error"}
Upravit existující zakoupenou položku
Base URL:
https://clipsan.com/api/bought/edit/
Vyžadované parametry
- key – Chráněný klíč Clipsan účtu
- id – ID zakoupené položky
Nepovinné parametry
- product – ID produktu při změně produktu (Produkty definujete v nastavení Clipsanu)
Vlastní parametry
K zakoupené položce můžete přidávat další parametry z přednastavených nebo začít používat vlastní. Jejich nastavení a úpravu provádíte přímo v nastavení Clipsanu. Kódy přednastavených parametrů jsou tyto: serialno,price,type,check,guarantee,note
Při použití parametru je nutné přidat před jeho název předložku „data_“. Výsledný parametr pro poslední kontakt je tedy data_price, parametr pro zemi data_type apod.
U položky jsou upraveny pouze parametry, které jsou nastaveny při volání. Ostatní parametry zůstávají beze změny.
Odpověď
{"result":"ok","bought":{"id":7,"product":"1","added":1433143830,"deleted":null,"params":{"price":"1234"}}}
Příklady
Příklad volání (základní úprava zakoupené položky)
https://clipsan.com/api/bought/add/key/VASKLIC/id/12345/product/5
https://clipsan.com/api/bought/add/?key=VASKLIC&id=12456&product=5
Příklad odpovědi
{"result":"ok","bought":{"id":12345,"product":"5","added":1433143830,"deleted":null,"params":{"price":"1234"}}}
Příklad volání (úprava zakoupené položky s vlastními parametry)
https://clipsan.com/api/bought/add/key/VASKLIC/id/12345/data_price/999/data_expire/2015-01-01
https://clipsan.com/api/bought/add/?key=VASKLIC&id=12345&data_price=999&data_expire=2015-01-01
Příklad odpovědi
{"result":"ok","bought":{"id":12345,"product":"5","added":1433143830,"deleted":null,"params":{"price":"999","expire":"2015-01-01"}}}
Příklad volání (neexistující položka)
https://clipsan.com/api/bought/add/key/VASKLIC/?id=12344
https://clipsan.com/api/bought/add/?key=VASKLIC&id=12344
Příklad odpovědi
{"error":"bought item not found","result":"error"}
Příklad volání (neexistující produkt)
https://clipsan.com/api/bought/add/key/VASKLIC/?id=12345&product=999
https://clipsan.com/api/bought/add/?key=VASKLIC&id=12345&product=999
Příklad odpovědi
{"error":"product not found","result":"error"}
Smazat zakoupenou položku
Base URL:
https://clipsan.com/api/bought/delete/
Vyžadované parametry
- key – Chráněný klíč Clipsan účtu
- id – ID zakoupené položky
Odpověď
{"result":"ok"}
Příklady
Příklad volání (smazání zakoupené položky)
https://clipsan.com/api/bought/delete/key/VASKLIC/id/5
https://clipsan.com/api/bought/delete/?key=VASKLIC&id=5
Příklad odpovědi
{"result":"ok"}
Příklad volání (neexistují položka)
https://clipsan.com/api/bought/delete/key/VASKLIC/id/0
https://clipsan.com/api/bought/delete/?key=VASKLIC&id=0
Příklad odpovědi
{"error":"bought item not found","result":"error"}