API rozhraní slouží pro komunikaci externích aplikací s CERP CZ. Data z CERP tak můžete zpřístupnit na Vašich www stránkách (vetrinární ordinace, obec, e-shop...) či v aplikacích. API disponuje celkem třemi typy úrovně oprávnění uživatelů.
Úroveň oprávnění 1 je k dispozici komukoliv bez omezení, regulován je pouze maximální počet přístupů za čas, který je balancován pro konkrétní přístupové adresy v závislosti na vytížení serverů a síťových prvků.
Volání API provedete pomocí metody GET, kde RFID je patnáctimístné číslo čipu psahttps://www.cerp.cz/ext/1/RFID
Návratové hodnoty představují následující čísla nebo chybové stavy:
| 0 | ID čipu nebylo nalezeno |
| 1 | ID čipu bylo nalezeno |
| ERR2 | ID čipu není ve formátu integer 15 míst |
| ERR3 | Překročen počet přístupů za čas |
| ERR4 | IP nebo MAC je na blacklistu |
| ERR6 | Obecná chyba oprávnění |
Úroveň oprávnění 2 je přístupná pouze pro uživatele, kteří s námi uzavřou Zpracovatelskou smlouvu o zpracování dat psů. Těmto uživatelům budou zpřístupněna rozšířená data o psech, která jejich vlastníci označili jako veřejná
Volání API provedete pomocí metody GET, kde RFID je patnáctimístné číslo čipu psa a KEY je Váš přístupový klíčhttps://www.cerp.cz/ext/2/RFID/KEY
Návratové hodnoty představují následující čísla, xml nebo chybové stavy:
| 0 | ID čipu nebylo nalezeno |
| ERR2 | ID čipu není ve formátu integer 15 míst |
| ERR3 | Překročen počet přístupů za čas |
| ERR4 | IP nebo MAC je na blacklistu |
| ERR5 | Přístupový klíč není platný |
| ERR6 | Obecná chyba oprávnění |
| <?xml ... | ID čipu bylo nalezeno, data jsou v xml dle následujícího schematu: |
<?xml version="1.0" encoding="UTF-8"?>
<PES>
<ID>UID čipu (INT 15)</ID>
<QT>Počet reg. psů pod vlastníkem hledaného psa (INT, rozsah 1 - 999999)</QT>
<RS>Rasa psa dle číselníku (INT, rozsah 1 - 1000)</RS>
<JM>Jméno psa (VARCHAR 128)</JM>
<PP>Průkaz původu (VARCHAR 128)</PP>
<DN>Datum narození (ve formátu DD.MM.RRRR)</DN>
<IM>URL fotografie psa (https://www.cerp.cz/i/__xxx__.jpg)</IM>
<PO>Pohlaví (INT 1, 1 = pes, 0 = fena)</PO>
<TC>Tetovací číslo (VARCHAR 128)</TC>
<SB>Barva srsti (VARCHAR 128)</SB>
<SD>Druh srsti (VARCHAR 128)</SD>
<PO>Poznámka majitele (VARCHAR 1200)</PO>
</PES>
Úroveň oprávnění 3 je přístupná pouze pro uživatele, kteří s námi uzavřou Zpracovatelskou smlouvu o zpracování osobních dat. Těmto uživatelům budou zpřístupněna rozšířená data o psech i jejich majitelích, která jejich vlastníci označili jako veřejná
Formát, autorizace a protokol vstupních i výstupních dat API rozhraní bude řešen dle požadavku zákazníka (SOAP, POST, JSON, XML...).