Rest API

Pokud chcete využívat funkcionalit Foxentry ve své aplikaci, interním systému či kdekoliv, kde se nehodí implementace pomocí scriptu, můžete využít služeb našeho API, které pracuje na REST principu. Pokud implementujete do PHP prostředí, doporučujeme využít již vytvořenou PHP knihovnu.

Založte si svůj API projekt

  • Kliknutím na tlačítko (bod č. 1) ve vašem úvodním dashboardu se dostanete do formuláře pro vytváření nových projektů.
  • V dalších krocích si pojmenujte váš projekt a zvolte, zda chcete projekt vytvořit pro sebe nebo pro svého klienta jako správce.
  • jelikož chceme založit projekt pro API, zvolíme možnost Aplikace (bod č. 2).

TIP: Detailnější informace o vytváření projektu najdete zde

 

Vytvořte si svůj API klíč a začněte testovat

Na každý nově vytvořený projekt přidáváme automaticky 5 000 kreditů se 14 denní platností tak, abyste si vše mohli v klidu otestovat. Po založení projektu je potřeba akorát vytvořit si svůj první API klíč a v případě potřeby nastavit si pro něj omezení dle IP adres. Učiníte tak následovně:

  • v právě vytvořeném projektu klikněte na Nastavení (bod č. 4).
  • klikneme na možnost API klíče (bod č. 5). Zde se vám budou zobrazovat všechny vaše API klíče.
  • Dále klikněte na Vytvořit API klíč.

Jakmile budete mít svůj první API klíč vytvořen, můžete přejít na naši dokumentaci a reálně vyzkoušet veškerou funkcionalitu Foxentry:

Rest API dokumentace – Apiary
PHP knihovna – Github