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.

Výpis seznamu plateb

Base URL:
https://clipsan.com/api/purchase/list/

Vyžadované parametry

  • key – Chráněný klíč Clipsan účtu

Volitelné parametry

  • entity – ID firemních údajů
  • price – ID nabídky
  • lead – ID kontaktu, k němuž je platba napojena
  • email – Email zákazníka
  • custom – Vlastní identifikační pole
  • membership – ID členství
  • state – Stav platby (init, cancelled, paid, refund, finished, sent, bounce)

Odpověď

  • result – Výsledek požadavku
  • count – Počet záznamů
  • data – Seznam plateb
  • id – ID platby
  • lead – ID kontaktu
  • membership – ID členství
  • price – ID nabídky
  • funnel – ID automatu
  • name – Název objednávky
  • type – Typ objednávky (online, hand, bank, cod, cc, paypal, stripe)
  • state – Stav objednávky (init, cancelled, paid, refund, finished, sent, bounce)
  • count – Počet položek
  • amount – Cena bez DPH
  • transfer – Cena za dopravu
  • cod – Cena za dobírku
  • proforma – Kód zálohové faktury
  • invoice – Kód daňového dokladu
  • repeat – Pořadí platby v případě členství
  • added – Timestamp data a času vytvoření
  • paid – Timestamp data a času zaplacení
  • deleted – Timestamp data a času smazání

Příklad volání

https://clipsan.com/api/purchase/list/key/VASKLIC/entity/IDENTITY/email/vaclav
https://clipsan.com/api/purchase/list/?key=VASKLIC&entity=IDENTITY&email=vaclav

Příklad odpovědi

{"result":"ok","count":1,"data":{"1234":{"id":1234,"lead":12345,"membership":null,"price":null,"funnel":530,"name":null,"custom":"","type":"online","state":"cancelled","count":1,"amount":440,"currency":"czk","tranfer":null,"cod":null,"vat":null,"proforma":"FV961001","invoice":null,"repeat":0,"added":1463062409,"paid":null,"deleted":null}}}

Vytvoření platby (nabídka definovaná v Clipsanu)

Base URL:
https://clipsan.com/api/purchase/add/

Vyžadované parametry

  • key – Chráněný klíč Clipsan účtu
  • price – ID nabídky
  • email – Email kontaktu (Pokud kontakt neexistuje, je vytvořen.)

Nepovinné parametry

  • first_name – Křestní jméno
  • last_name – Příjmení
  • name – Celé jméno
  • phone – Telefon
  • street – Ulice
  • city – Město
  • zip – Poštovní směrovací číslo
  • country – ISO kód země např. CZ
  • company – Celé jméno
  • company_street – Ulice firmy
  • company_city – Město firmy
  • company_zip – Poštovní směrovací číslo firmy
  • company_id – IČ
  • company_vat – DIČ resp. DPH IČ pro SK
  • count – Počet položek
  • amount – Částka za položku
  • type – Typ platby s možnostmi online [výběr uživatele], cc [platební karta], bank [převodem] nebo cod [dobírka]
  • transfer – Částka za poštovné
  • cod – Částka za dobírku
  • custom – Vlastní identifikační pole
  • nofunnel – Vypnout zasílání emailů z automatu

Odpověď

  • result – Výsledek požadavku
  • purchase – Záznam vytvořené platby
  • id – ID platby
  • lead – ID kontaktu
  • membership – ID členství
  • price – ID nabídky
  • funnel – ID automatu
  • name – Název objednávky
  • type – Typ objednávky (online, hand, bank, cod, cc, paypal, stripe)
  • state – Stav objednávky (init, cancelled, paid, refund, finished, sent, bounce)
  • count – Počet položek
  • amount – Cena bez DPH
  • transfer – Cena za dopravu
  • cod – Cena za dobírku
  • proforma – Kód zálohové faktury
  • invoice – Kód daňového dokladu
  • repeat – Pořadí platby v případě členství
  • added – Timestamp data a času vytvoření
  • paid – Timestamp data a času zaplacení
  • deleted – Timestamp data a času smazání
  • address – Údaje o zákazníkovi
  • url – Adresa s detailem objednávky

Příklady

Příklad volání 

https://clipsan.com/api/purchase/add/?key=VASKLIC&price=ID&email=support@clipsan.com

Příklad odpovědí
{"result":"error","error":"price not found"}
{"result":"error","error":"invalid email"}
{"result":"ok","purchase":{"id":1,"lead":"1","membership":null,"price":"1","funnel":"1","name":"Program XYZ 2016","custom":null,"type":"online","state":"init","count":1,"amount":1000,"tranfer":null,"cod":null,"vat":0,"proforma":"FV961369","invoice":null,"repeat":0,"added":1459776325,"paid":null,"deleted":null,"address":{"name":"Vaclav","email":"support@clipsan.com","phone":"+420123456789","note":null,"street":"Dominikanska 6","city":"Plzen","zip":30100,"country":"cz","company":"Clipsan s.r.o.","company_street":"Dominikanska 6","company_city":"Plzen","company_zip":"90301","company_id":"28045998","company_vat":"CZ28045998"}, "url":"https:\/\/vasefirma.clipsan.com\/cs\/produkt\/potvrzeni"}}

Vytvoření platby (nabídka nezávislá na Clipsanu)

Base URL:
https://clipsan.com/api/purchase/add/

Vyžadované parametry

  • key – Chráněný klíč Clipsan účtu
  • entity – ID fakturující firmy – naleznete na https://clipsan.com/cs/sales/entity
  • list – Hash ID skupiny, do které kontakt zařadit – naleznete na https://clipsan.com/cs/marketing/list. Parametr může být i pole např. list[]=12345&list[]=67890
  • funnel – ID automatu s upomínkami – naleznete na https://clipsan.com/cs/marketing/funnel
  • email – Email kontaktu (Pokud kontakt neexistuje, je vytvořen.)
  • name – Označení objednávky (např. Objednávka č. 6)
  • items – Pole s položkami objednávky zakódované přes JSON

Parametry položky

  • name – Název položky
  • code – Vlastní kód položky
  • description – Popis položky
  • price – Cena položky (bez DPH)
  • vat – Sazba DPH
  • count – Počet objednaných položek
  • digital – Označení digitálního produktu

Nepovinné parametry

  • first_name – Křestní jméno
  • last_name – Příjmení
  • name – Celé jméno
  • phone – Telefon
  • street – Ulice
  • city – Město
  • zip – Poštovní směrovací číslo
  • country – ISO kód země např. CZ
  • currency – ISO kód měny (CZK, EUR, USD)
  • company – Celé jméno
  • company_street – Ulice firmy
  • company_city – Město firmy
  • company_zip – Poštovní směrovací číslo firmy
  • company_id – IČ
  • company_vat – DIČ resp. DPH IČ pro SK
  • custom – Vlastní identifikační pole
  • nofunnel – Vypnout zasílání emailů z automatu
  • type – Typ platby s možnostmi online [výběr uživatele], cc [platební karta], bank [převodem] nebo cod [dobírka]

Odpověď viz předchozí volání

Příklady

Příklad volání 

https://clipsan.com/api/purchase/add/?key=VASKLIC&entity=123&list=aaa&funnel=123&email=support@clipsan.com&name=Objednavka+3&items[]={"price":100,"vat":21,"count":1,"name":"Polozka%201","code":"P1","description":"Popis%20polozky%201","digital":true}&items[]={"price":138.3,"vat":15,"count":2,"name":"Polozka%202","code":"P2","description":"Popis%20polozky%202","digital":false}

Příklad odpovědí
{"result":"error","error":"entity not found"}
{"result":"error","error":"invalid email"}
{"result":"ok","purchase":{"id":1,"lead":"1","membership":null,"price":"1","funnel":"1","name":"Objednavka 3","custom":null,"type":"online","state":"init","count":1,"amount":1000,"tranfer":null,"cod":null,"vat":0,"proforma":"FV961369","invoice":null,"repeat":0,"added":1459776325,"paid":null,"deleted":null,"address":{"name":"Vaclav","email":"support@clipsan.com","phone":"+420123456789","note":null,"street":"Dominikanska 6","city":"Plzen","zip":30100,"country":"cz","company":"Clipsan s.r.o.","company_street":"Dominikanska 6","company_city":"Plzen","company_zip":"90301","company_id":"28045998","company_vat":"CZ28045998"}, "url":"https:\/\/vasefirma.clipsan.com\/cs\/produkt\/potvrzeni","items":[{"id":60,"name":"Polozka 1","code":"P1","description":"Popis polozky 1","price":100,"count":1,"vat":21,"digital":true,"added":"2016-05-12 13:45:37"},{"id":61,"name":"Polozka 2","code":"P2","description":"Popis polozky 2","price":138.3,"count":2,"vat":15,"digital":true,"added":"2016-05-12 13:45:37"}]}}

Detail platby

Base URL:
https://clipsan.com/api/purchase/view/

Vyžadované parametry

  • key – Chráněný klíč Clipsan účtu
  • id – ID platby

Odpověď viz vytvoření platby

Příklady

Příklad volání 

https://clipsan.com/api/purchase/view/?key=VASKLIC&id=ID

Příklad odpovědi
{"result":"ok","purchase":{"id":1,"lead":"1","membership":null,"price":"1","funnel":"1","name":"Program XYZ 2016","custom":null,"type":"online","state":"init","count":1,"amount":1000,"tranfer":null,"cod":null,"vat":0,"proforma":"FV961369","invoice":null,"repeat":0,"added":1459776325,"paid":null,"deleted":null,"address":{"name":"Vaclav","email":"support@clipsan.com","phone":"+420123456789","note":null,"street":"Dominikanska 6","city":"Plzen","zip":30100,"country":"cz","company":"Clipsan s.r.o.","company_street":"Dominikanska 6","company_city":"Plzen","company_zip":"90301","company_id":"28045998","company_vat":"CZ28045998"}, "url":"https:\/\/vasefirma.clipsan.com\/cs\/produkt\/potvrzeni"}}

Smazání platby

Base URL:
https://clipsan.com/api/purchase/delete/

Vyžadované parametry

  • key – Chráněný klíč Clipsan účtu
  • id – ID platby

Odpověď viz vytvoření platby

Příklady

Příklad volání 

https://clipsan.com/api/purchase/delete/?key=VASKLIC&id=ID

Příklad odpovědi
{"result":"ok","purchase":{"id":1,"lead":"1","membership":null,"price":"1","funnel":"1","name":"Program XYZ 2016","custom":null,"type":"online","state":"init","count":1,"amount":1000,"tranfer":null,"cod":null,"vat":0,"proforma":"FV961369","invoice":null,"repeat":0,"added":1459776325,"paid":null,"deleted":1459776325,"address":{"name":"Vaclav","email":"support@clipsan.com","phone":"+420123456789","note":null,"street":"Dominikanska 6","city":"Plzen","zip":30100,"country":"cz","company":"Clipsan s.r.o.","company_street":"Dominikanska 6","company_city":"Plzen","company_zip":"90301","company_id":"28045998","company_vat":"CZ28045998"}, "url":"https:\/\/vasefirma.clipsan.com\/cs\/produkt\/potvrzeni"}}

Detail členství

Base URL:
https://clipsan.com/api/membership/view/

Vyžadované parametry

  • key – Chráněný klíč Clipsan účtu
  • id – ID členství

Odpověď

  • result – Výsledek volání
  • membership – Záznam členství
  • id – ID členství
  • lead – ID kontaktu
  • price – ID nabídky
  • period – Délka intervalu členství
  • start – Timestamp začátku členství
  • until – Platnost členství do
  • end – Konec členství
  • purchases – Objednávky/platby za členství
  • id – ID platby
  • repeat – Pořadové číslo platby

Příklady

Příklad volání 

https://clipsan.com/api/membership/view/?key=VASKLIC&id=ID

Příklad odpovědi
{"result":"ok","membership":{"id":1,"lead":"1","period":30,"start":1452541634,"until":1460314030,"end":null,"purchases":[{"id":1001,"repeat":0},{"id":1002,"repeat":1},{"id":1003,"repeat":2}]}}

Úprava členství

Base URL:
https://clipsan.com/api/membership/update/

Vyžadované parametry

  • key – Chráněný klíč Clipsan účtu
  • id – ID členství

Volitelné parametry

  • price – ID nabídky
  • period – Délka intervalu členství
  • until – Platnost členství do
  • end – Konec členství

Odpověď

  • result – Výsledek volání
  • membership – Záznam členství
  • id – ID členství
  • lead – ID kontaktu
  • price – ID nabídky
  • period – Délka intervalu členství
  • start – Timestamp začátku členství
  • until – Platnost členství do
  • end – Konec členství
  • purchases – Objednávky/platby za členství
  • id – ID platby
  • repeat – Pořadové číslo platby

Příklady

Příklad volání 

https://clipsan.com/api/membership/update/?key=VASKLIC&id=ID&price=XYZ&until=1452541634&period=30

Příklad odpovědi
{"result":"ok","membership":{"id":1,"lead":"1","period":30,"start":1452541634,"until":1460314030,"end":null,"purchases":[{"id":1001,"repeat":0},{"id":1002,"repeat":1},{"id":1003,"repeat":2}]}}

Napsat komentář

Vaše emailová adresa nebude zveřejněna. Vyžadované informace jsou označeny *