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 uživatelů

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

Vyžadované parametry

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

Příklady

Příklad volání 

https://clipsan.com/api/user/list/key/VASKLIC/
https://clipsan.com/api/user/list/?key=VASKLIC

Příklad odpovědi
{"result":"ok","data":{"14":{"id":14,"email":"vaclav.krajnak@clipsan.com","name":"V\u00e1clav Kraj\u0148\u00e1k","role":"owner","added":1354184510}}}

Přidat nového uživatele

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

Vyžadované parametry

  • key – Chráněný klíč Clipsan účtu
  • email – Email uživatele (musít být unikátní mezi všemi Clipsan účty)

Volitelné parametry

  • name – Jméno uživatele
  • password – Heslo uživatele (pokud není uvedeno, je vygenerováno náhodné)
  • role – Role uživatele (owner, user) – výchozí role je user
  • welcome – (Hodnota 0/1) Posílat informační email s přístupovými údaji.

Odpověď
{"result":"ok","id":"ID nového uživatele"}

Příklady

Příklad volání (základní přidání uživatele)

https://clipsan.com/api/user/add/key/VASKLIC/email/vaclav.krajnak%40ciwire.biz

Příklad odpovědi
{"result":"ok","id":"101"}

Příklad volání (plné přidání uživatele)

https://clipsan.com/api/user/add/key/VASKLIC/email/vaclav.krajnak@ciwire.biz/name/vaclav+krajnak/password/123456/role/user/welcome/1

Příklad odpovědi
{"result":"ok","id":"101"}

Příklad volání (duplicitní uživatel)

https://clipsan.com/api/user/add/key/VASKLIC/email/vaclav.krajnak%40ciwire.biz

Příklad odpovědi
{"result":"error","error":"user already exists"}

Smazat existujícího uživatele

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

Vyžadované parametry

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

Volitelné parametry

  • id – ID uživatele (má přednost před emailem)
  • email – Email uživatele (pokud, není zádáno ID, vyhledán uživatel)

Odpověď
{"result":"ok"}

Příklady

Příklad volání (smazání uživatele podle emailu)

https://clipsan.com/api/user/delete/key/VASKLIC/email/vaclav.krajnak%40ciwire.biz
https://clipsan.com/api/user/delete/?key=VASKLIC&email=vaclav.krajnak%40ciwire.biz

Příklad odpovědi

{"result":"ok"}

Příklad volání (neexistující uživatel)

https://clipsan.com/api/user/add/key/VASKLIC/email/vaclav.krajnak%40ciwire.biz
https://clipsan.com/api/user/delete/?key=VASKLIC&email=vaclav.krajnak%40ciwire.biz

Příklad odpovědi
{"result":"error","error":"user not found"}

Odkaz pro automatické přihlášení

Base URL:
https://clipsan.com/api/user/login/

Vyžadované parametry

  • email – Email uživatele
  • t – Časová značka (Unix timestamp) nesmí být starší než 30 minut
  • h – MD5 hash řetězce (email + t + chráněný klíč)
  • r – URL adresa přesměrování

Příklady

Příklad odkazu

https://clipsan.com/api/user/login/email/vaclav.krajnak%40ciwire.biz/t/1417220223/h/0a67a5768baad59ac393cca8e3a94193
https://clipsan.com/api/user/login/?email=vaclav.krajnak%40ciwire.biz&t=1417220223&h=0a67a5768baad59ac393cca8e3a94193

MD5 hash pro (vaclav.krajnak@ciwire.biz1417220223kdk1739fdkso)

Seznam účtů

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

Vyžadované parametry

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

Příklady

Příklad volání

https://clipsan.com/api/account/list/key/VASKLIC/
https://clipsan.com/api/account/list/?key=VASKLIC

Příklad odpovědi
{"result":"ok","data":{"2":{"id":1,"name":"V\u00e1clav Kraj\u0148\u00e1k","email":"vaclav.krajnak@clipsan.com","securekey":"ef08e9ca7dea0d2xu145","added":1372055493}}}

Přidat nový účet

Vytvářen nové účty v Clipsanu mohou pouze vybraní partneři. Všichni ostatní dostanou zpět hlášení o nedostatečných právech.

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

Vyžadované parametry

  • key – Chráněný klíč Clipsan účtu
  • email – Email zakládajícího uživatele (musít být unikátní mezi všemi Clipsan účty)

Volitelné parametry

  • name – Jméno účtu
  • companyid – IČO účtu
  • username – Jméno uživatele
  • password – Heslo uživatele (pokud není uvedeno, je vygenerováno náhodné)
  • welcome – (Hodnota 0/1) Posílat informační email s přístupovými údaji.

Odpověď
{"result":"ok","id":"ID nového účtu","securekey":"chráněný klíč"}

Příklady

Příklad volání (základní přidání účtu)

https://clipsan.com/api/account/add/key/VASKLIC/email/vaclav.krajnak%40ciwire.biz
https://clipsan.com/api/account/add/?key=VASKLIC&email=vaclav.krajnak%40ciwire.biz

Příklad odpovědi
{"result":"ok","id":"1001","securekey":"dsdisjisdj"}
Příklad volání (plné přidání účtu)
https://clipsan.com/api/user/add/key/VASKLIC/email/vaclav.krajnak@ciwire.biz/name/clipsansro/companyid/28045998/username/vaclav+krajnak/password/123456/role/user/welcome/1
https://clipsan.com/api/account/add/?key=VASKLIC&email=vaclav.krajnak%40ciwire.biz&name=clipsansro&companyid=28045998&username=vaclav+krajnak&password=123456&role=user&welcome=1

Příklad odpovědi
{"result":"ok","id":"1002","securekey":"dsdisjisdj"}
Příklad volání (duplicitní uživatel)
https://clipsan.com/api/user/add/key/VASKLIC/email/vaclav.krajnak%40ciwire.biz
https://clipsan.com/api/account/add/?key=VASKLIC&email=vaclav.krajnak%40ciwire.biz

Příklad odpovědi

{"result":"error","error":"user already exists "}

Příklad volání (nedostatečná práva)

https://clipsan.com/api/user/add/key/VASKLIC/email/vaclav.krajnak%40ciwire.biz
https://clipsan.com/api/account/add/?key=VASKLIC&email=vaclav.krajnak%40ciwire.biz

Příklad odpovědi
{"result":"error","error":"insufficient rights"}

Napsat komentář

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