Typografika.pl

v0.14

Nowy klucz API

Aby otrzymać klucz API należy wypełnić poniższy formularz.

Na podany adres e-mail zostanie przesłany klucz.

Opis API

Każde zapytanie wymaga prawidłowego klucza API.

/api/typograf/

Wywołanie funkcji: http://www.typografika.pl/api/typograf/klucz_api/ (uwaga na kończący slash!)

W zmiennej POST o nazwie text należy przesłać tekst przeznaczony do konwersji.

Zwrócony zostanie obiekt XML w następującym formacie:

<?xml version="1.0" encoding="utf-8"?>
<result>
<code>kod</code>
  <message>odpowiedź</message>
  <text>tekst</text>
</result>

kod - kod odpowiedzi serwera

wiadomość - powiązana z kodem. Opis błędu który wystąpił lub stwierdzenie poprawności

Wartości pola kod i przypisane im wiadomości:

200 OK - poprawna konwersja, tekst jest tekstem po konwersji
204 No content. Please provide text. - brak tekstu przesłanego przez POST
401 Unauthorized. Please provide valid API key. - nieprawidłowy klucz API lub jego brak.

Przykład wywołania w PHP przy użyciu cURL:

$api_key = "APIKEY12345";
$text = "Tekst do konwersji";
	
$curl_session = curl_init();
curl_setopt($curl_session, CURLOPT_URL, "http://www.typografika.pl/api/typograf/".$api_key."/");
curl_setopt($curl_session, CURLOPT_POST, 1);
curl_setopt($curl_session, CURLOPT_POSTFIELDS, "text=".$text);
curl_setopt($curl_session, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl_session, CURLOPT_CONNECTTIMEOUT, 4);
curl_setopt($curl_session, CURLOPT_TIMEOUT, 8);
$data = curl_exec($curl_session);
curl_close($curl_session);

W razie uwag lub pytań prosimy o kontakt.