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.
Seznam úkolů
Base URL:
https://clipsan.com/api/task/list/
Vyžadované parametry
- key – Chráněný klíč Clipsan účtu
Volitelné parametry
- user – ID uživatele
- email – Email uživatele
- modified – Datum, od kdy zobrazovat úkoly (Unix timestamp)
Příklady
Příklad volání
https://clipsan.com/api/task/list/key/VASKLIC/userid/3114
https://clipsan.com/api/task/list/?key=VASKLIC&userid=3114
Příklad odpovědi
{"result":"ok","data":{"1":{"id":1,"user":"3114","lead":null,"company":"3","deal":null,"category":"Ble 2","name":"\u00dakol","description":"Podrobnosti","reminder":null,"start":null,"duration":0,"duedate":null,"state":"done","priority":"high","private":true,"added":1413657057,"deleted":null},"2":{"id":2,"user":"3114","lead":null,"company":"3","deal":null,"category":null,"name":"Nov\u00fd \u00fakol","description":"Popis","reminder":{},"start":1417388400,"duration":8,"duedate":1419980400,"state":"open","priority":"normal","private":false,"added":1414796400,"deleted":null}}}
Přidat nový úkol
Base URL:
https://clipsan.com/api/task/add/
Vyžadované parametry
- key – Chráněný klíč Clipsan účtu
- name – Název úkolu
Volitelné parametry
- user – ID uživatele nebo email, komu tento úkol přiřadit
- creator – ID uživatele nebo email, kdo tento úkol vytvořil
- lead – ID kontaktu, email nebo rodné číslo
- company – ID firmy nebo IČO (nejprve je zkoušeno ID)
- deal – ID příležitosti
- category – Kategorie
- description – Popis úkolu
- reminder – Datum upozornění (zaslání emailu)
- start – Datum začátku
- duedate – Datum nutného splnění
- duration – Délka trvání v minutách
- state – Stav úkolu (open,done,progress)
- priority – Priorita úkolu (normal,high,top,low)
- private – Úkol je soukromý (nutno zadat uživatele)
- mute – (Hodnota 0/1) Neposílat informační email o novém úkolu.
Odpověď
{"result":"ok","id":"ID nového úkolu"}
Příklady
Příklad volání ( základní přidání úkolu)
https://clipsan.com/api/task/add/key/VASKLIC/name/novy+ukol
https://clipsan.com/api/task/add/?key=VASKLIC&name=novy+ukol
Příklad odpovědi
{"result":"ok","id":"1001"}
Příklad volání ( základní přidání úkolu pro uživatele a kontakt)
https://clipsan.com/api/task/add/key/VASKLIC/name/novy+ukol/user/vaclav%40clipsan.com/lead/vomacka%40iphone.com
https://clipsan.com/api/task/add/?key=VASKLIC&name=novy+ukol&user=vaclav%40clipsan.com&lead=vomacka%40iphone.com
Příklad odpovědi
{"result":"ok","id":"1002"}
Příklad volání (neexistující kontakt)
https://clipsan.com/api/task/add/key/VASKLIC/name/novy+ukol/user/vaclav%40clipsan.com/lead/vomacka%40iphone.us
https://clipsan.com/api/task/add/?key=VASKLIC&name=novy+ukol&user=vaclav%40clipsan.com&lead=vomacka%40iphone.us
Příklad odpovědi
{"result":"error","error":"lead not found"}
Upravit úkol
Base URL:
https://clipsan.com/api/task/edit/
Vyžadované parametry
- key – Chráněný klíč Clipsan účtu
- id – ID úkolu
Volitelné parametry
- user – ID uživatele nebo email, komu tento úkol přiřadit
- creator – ID uživatele nebo email, kdo tento úkol vytvořil
- lead – ID kontaktu, email nebo rodné číslo
- company – ID firmy nebo IČO
- deal – ID příležitosti
- category – Kategorie
- name – Název úkolu
- description – Popis úkolu
- reminder – Datum upozornění (zaslání emailu)
- start – Datum začátku
- duedate – Datum nutného splnění
- duration – Délka trvání v minutách
- state – Stav úkolu (open,done,progress)
- priority – Priorita úkolu (normal,high,top,low)
- private – Úkol je soukromý (nutno zadat uživatele)
Odpověď
{"result":"ok"}
Příklady
Příklad volání ( základní úprava úkolu)
https://clipsan.com/api/task/edit/key/VASKLIC/id/1001/name/novejsi+ukol
https://clipsan.com/api/task/edit/?key=VASKLIC&id=1001&name=novejsi+ukol
Příklad odpovědi
{"result":"ok"}
Příklady volání (neexistující úkol)
https://clipsan.com/api/task/edit/key/VASKLIC/id/999/name/novejsi+ukol
https://clipsan.com/api/task/edit/?key=VASKLIC&id=999&name=novejsi+ukol
Příklad odpovědi
{"result":"error","error":"task not found"}
Zobrazit úkol
Base URL:
https://clipsan.com/api/task/view/
Vyžadované parametry
- key – Chráněný klíč Clipsan účtu
- id – ID úkolu
Odpověď
{"result":"ok",task:{ }}
Příklady
Příklad volání (základní úprava úkolu)
https://clipsan.com/api/task/view/key/VASKLIC/id/1001
https://clipsan.com/api/task/view/?key=VASKLIC&id=1001
Příklad odpovědi
{"result":"ok","task":{"id":1001,"user":114,"lead":"50877","company":"3","deal":null,"category":"test","name":"12345","description":"desc","reminder":null,"start":null,"duration":0,"duedate":1388531700,"state":"done","priority":"high","private":true,"added":1417653009,"deleted":null}}
Příklad volání (neexistující úkol)
https://clipsan.com/api/task/view/key/VASKLIC/id/999
https://clipsan.com/api/task/view/?key=VASKLIC&id=999
Příklad odpovědi
{"result":"error","error":"task not found"}
Smazat úkol
Base URL:
https://clipsan.com/api/task/delete/
Vyžadované parametry
- key – Chráněný klíč Clipsan účtu
- id – ID úkolu
Odpověď
{"result":"ok"}
Příklady
Příklad volání (smazání úkolu)
https://clipsan.com/api/task/delete/key/VASKLIC/id/1
https://clipsan.com/api/task/edit/?key=VASKLIC&id=1
Příklad odpovědi
{"result":"ok"}
Příklad volání (neexistující úkol)
https://clipsan.com/api/task/delete/key/VASKLIC/id/0
https://clipsan.com/api/task/edit/?key=VASKLIC&id=0
Příklad odpovědi
{"result":"error","error":"task not found"}