Download the PHP package yarri/master-api-client without Composer
On this page you can find all versions of the php package yarri/master-api-client. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download yarri/master-api-client
More information about yarri/master-api-client
Files in yarri/master-api-client
Package master-api-client
Short Description Client for Master API
License MIT
Homepage https://github.com/yarri/MasterApiClient
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package master-api-client
Master API klient pro PHP
Pomoci klienta je mozne odesilat prikazy, ktere budou okamzite na strane Master API serveru provedeny. Napriklad registrace domeny muze byt realizovana na jediny HTTP pozadavek; celkovy cas potrebny pro registraci nebude delsi nez jen nekolik malo vterin.
Klient je testovan na PHP verze 5.3 a 4.4.
Klient komunikuje na HTTP protokolu pres SSL. Pro navazani socketoveho spojeni pres SSL je nutne do PHP nainstalovat rozsireni OpenSSL.
Changelog
http://www.domainmaster.cz/masterapi/client/CHANGELOG
Potrebne knihovny
Soubory jsou soucasti dodavky.
Inicializace klienta
URL testovaciho serveru: http://test-api.domainmaster.cz/masterapi/server.php URL ostreho serveru: https://www.domainmaster.cz/masterapi/server.php
Testovaci Master API server je provozovan nad ne prilis aktualni kopii ostre databaze. Instance je napojena na testovaci rozhrani CZ.NICu. Pokud budete chtit vyzkouset testovaci Master API server, kontaktujte nas e-mailem na adrese info[at]generalregistry[dot]cz.
Pomoci parametru "charset" je mozne nastavit pouzitou znakovou sadu, ve ktere budou zasilany parametry prikazu (napr. u registrace kontaktu pro .cz domeny).
Implementace klienta
Volanim metody SendCommand() bude odeslan prikaz do Master API serveru. Vracen bude objekt, ktery popisuje 3 stavy:
-
akce dopadla uspesne - pozadavek byl beze zbytku vyrizen
-
doslo k chybe - pozadavek neni mozne zpracovat, duvodem muze byt syntakticka chyba v parametrech, pokus o registraci jiz existujici domeny a podobne.
- doslo k docasne chybe - prikaz neni mozne z nejake docasne chyboveho stavu realizovat; v takovem pripade je nutne nejakou dobu pockat (5 minut) a odeslat stejny prikaz znovu; POZOR!!! - o realizaci prikazu se opakovane nebude pokouset nas automat
Volanim metody getMessage() u navratoveho objektu lze zjistit popis pripadne chyby.
Nektere typy prikazu vyzaduji parametry. Tyto parametry vychazeji z e-mailoveho API. Dokumentace k e-mailovemu API je zde: http://www.domainmaster.cz/doc/auto_reg_cz_enum.pdf
Jiste prikazy vraceji nejaka data (napr. "list domains"). Metodou getData() lze tato data ziskat. Vraceno je asociativni pole.
Penaltovy system
Master API zaznamenava pozadavky, ktere skoncily chybou (nikoli docasnou). Pri dosazeni urciteho poctu chyb bude klient pred pouzitim Master API blokovan:
- po dosazeni 2 chyb je klient blokovan do konce aktualni minuty
- po dosazeni 6 chyb je klient blokovan do konce aktualni hodiny
Je-li klient blokovan, bude mu na kazdy dalsi prikaz vracena docasna chyba se zpravou: "you are blocked from the Master API because of abusive usage"
Funkce Master Api
Viz http://www.domainmaster.cz/master-api/dokumentace/
// vim: expandtab
