Skocz do zawartości

  • Zaloguj korzystając z Facebooka Zaloguj korzystając z Twittera Zaloguj przez Steam Zaloguj poprzez Google      Logowanie »   
  • Rejestracja

Czy byłeś już na AMXXowym serwerze TeamSpeak3?

Jeszcze nie? To na co czekasz! Zapraszamy, adres serwera to:
amxx.pl


Witamy w Nieoficjalnym polskim support'cie AMX Mod X

Witamy w Nieoficjalnym polskim support'cie AMX Mod X, jak w większości społeczności internetowych musisz się zarejestrować aby móc odpowiadać lub zakładać nowe tematy, ale nie bój się to jest prosty proces w którym wymagamy minimalnych informacji.

  • Rozpoczynaj nowe tematy i odpowiedaj na inne
  • Zapisz się do tematów i for, aby otrzymywać automatyczne uaktualnienia
  • Dodawaj wydarzenia do kalendarza społecznościowego
  • Stwórz swój własny profil i zdobywaj nowych znajomych
  • Zdobywaj nowe doświadczenia

Dołączona grafika Dołączona grafika

Guest Message by DevFuse
 

AMXX.pl API


Jako Support AMXX, wciąż dokładamy wszelkich starań, by sprostać coraz to większym i bardziej wysublimowanym oczekiwaniom użytkowników.
Dlatego też, oddajemy w Twoje ręce zaawansowane API, które pozwoli Ci pobrać wiele wartościowych zasobów z AMXX.pl w wygodnej formie.

Adreshttp://api.amxx.pl/gate.php


Wszystkie dane pobierane przez AMXX.pl API są kodowane w UTF-8
Wszystkie zapytania winny być dokonywane wyłącznie metodą GET
Każde zapytanie musi być wykonane z wymaganymi parametrami QSP

Każda odpowiedź jest poprzedzona 4 nagłówkami. Dwa pierwsze:
header('Access-Control-Allow-Origin: *');
header('Access-Control-Allow-Methods: GET');


Trzecim nagłówkiem jest kod odpowiedzi HTTP w zależności od odpowiedzi:
header('Status: 200 OK', true, 200);
header('Status: 400 Bad Request', true, 400);
header('Status: 406 Not Acceptable', true, 406);
header('Status: 412 Precondition Failed', true, 412);
header('Status: 415 Unsupported Media Type', true, 415);
header('Status: 500 Internal Server Error', true, 500);
header('Status: 501 Not Implemented', true, 501);


Czwarty nagłówek określa kodowanie UTF-8 oraz typ zwracanych danych i zależny jest od parametru ask

ask
Podstawowym parametrem, wymaganym w każdym zapytaniu jest parametr ask, identyfikujący rodzaj zapytania.
Dostępne parametry ask przedstawione są poniżej. Dokładny opis użycia parametru dla zapytań dostępny jest na dole strony.


format
Istotnym parametrem, dostępnym dla każdego zapytania, jest parametr format, identyfikujący format zwracanych danych przez AMXX.pl API.
Dostępne parametry format przedstawione są poniżej. Obsługujemy aż 5 różnych formatów odpowiedzi, by dogodzić Twoim praktykom.

dumpZrzut danych z tablicy

Standardowy var_dump na wynikach, pozwalający na dokładną analizę wizualną typów zwracanych danych.
header('Content-Type: text/plain; Charset=UTF-8');


exportEksport danych z tablicy

Eksponowany wewnątrz znaczkika <pre>, eksport wyników poprzez var_export(…, true).
Tak wyeksponowany wynik, pozwala na przejrzystą analizę wizualną wartości zwracanych danych.
header('Content-Type: text/html; Charset=UTF-8');


jsonJavaScript Object Notation

Standardowy obiekt JSON, używany do pobrania danych w celu późniejszego przetworzenia.
header('Content-Type: application/json; Charset=UTF-8');


jsonpJSON with parameter

Obiekt JSON, zwracany jako jedyny parametr funkcji o nazwie parametru callback.
callbackJSONP callback function

Z racji konieczności zwrócenia funkcji z obiektem JSON, przy wyborze tego formatu zwracanych danych,
wymaga się podania wspomnianego parametru callback, będącego nazwą zwracanej funkcji.
header('Content-Type: application/javascript; Charset=UTF-8');


xmlExtensible Markup Language

Standardowy dokument XML wersji 1.0, którego korzeniem jest element o nazwie xml.
Dane, wymagające ujęcia w znacznik CDATA (i tylko te!), zostały w nim umieszczone.
Wszelkie klucze liczbowe zostały poprzedzone przedrostkiem key_ by sprostać wymogom standardu.
header('Content-Type: application/xml; Charset=UTF-8');


Każda funkcja zwraca, w formacie zależnym od parametru format, dane postaci:
array (
  'success' => SUCCESS,
  DATA
)

SUCCESS - Stan powodzenia (ubi): 1 w przypadku powodzenia, 0 w przypadku błędu.
DATA : 'data' => RESPONSE w przypadku powodzenia, gdzie RESPONSE to zwrócone dane właściwe.
'error' => ERROR w przypadku błędu, gdzie ERROR to treść błędu (string).


Poniżej znajduje się pełna dokumentacja dostępnych metod w zależności od parametru ask
Niektóre metody mogą wymagać przesłania dodatkowych parametrów w celu obsłużenia zapytania.

Adreshttp://api.amxx.pl/gate.php?ask=funkcja

id
Pobiera dane funkcji o podanym identyfikatorze.

id = Identyfikator funkcji do pobrania (uint)

Zwracane wartości:

Informacje o funkcji (array):
sid => Identyfikator sekcji, do której należy funkcja (uint)
mid => Identyfikator modułu, do którego należy funkcja (uint)
name => Nazwa funkcji (string)
params => Parametry funkcji (array)
Dla każdego parametru funkcji (array):
id Identyfikator parametru (uint), kolejne liczby całkowite
=> Parametr funkcji (array)
name => Nazwa parametru (string), np. index
type => Typ parametru (string), np. bool
array => Przyrostek tablicy (string), np. []
default => Wartość domyślna parametru (string)
properties => Właściwości parametru (string), np. const
return => Zwracane wartości (HTML)
desc => Opis funkcji (HTML)
type => Typ funkcji (string): Natywny, Forward, Stock lub pusty string, jeśli typ jest nieokreślony
notes => Notatki (HTML)
example => Przykład (SMA)
comments => Komentarze (HTML)
author => Infomacje o autorze opisu funkcji (array)
id => Identyfikator użytkownika na AMXX.pl (uint)
name => Nazwa użytkownika (array)
plain => Prosta nazwa (string)
formatted => Sformatowana nazwa (HTML)
group => Grupa użytkownika (array)
id => Identyfikator grupy na AMXX.pl (uint)
name => Nazwa grupy (array)
plain => Prosta nazwa (string)
formatted => Sformatowana nazwa (HTML)
link => Link do profilu użytkownika na AMXX.pl (array)
plain => Czysty link (string)
formatted => Sformatowany link (HTML)
photo => Logo użytkownika (array)
full => Pełne logo (array)
plain => Adres do logo (string)
formatted => Sformatowany kod (znacznik IMG), wyświetlający logo (HTML)
thumb => Miniaturka logo (array), jw.
time => Data utworzenia opisu (unix time)
editor => Autor ostatniej modyfikacji (array), patrz: author
edit_time => Data ostatniej modyfikacji opisu (unix time)
auto => Stan opisu automatycznego (ubi): 1 - opis automatyczny, 0 - opis stworzony przez człowieka.

Przykład:

ids
Pobiera dane funkcji o podanych identyfikatorach.

ids = Identyfikatory funkcji do pobrania oddzielane przecinkami (/\d+(,\d+)*/)

Zwracane wartości:

Dla każdej z funkcji (array):
id Identyfikator funkcji, której dane pobieramy (uint)
=> Dane dotyczące funkcji (array), patrz: ask=funkcja&id



Przykład:

all
Pobiera dane wszystkich funkcji.

Zwracane wartości:

Dla każdej z funkcji (array):
id Identyfikator funkcji, której dane pobieramy (uint)
=> Dane dotyczące funkcji (array), patrz: ask=funkcja&id



count
Zwraca liczbę wszystkich funkcji.

Zwracane wartości:

count Liczba wszystkich funkcji (uint)


Przykład:

newest
Zwraca identyfikator najnowszej funkcji.

Zwracane wartości:

newest Identyfikator najnowszej funkcji (uint)


Przykład:

part
Pobiera wybraną porcję size funkcji: LIMIT(size * part, size)
part = Identyfikator porcji funkcji do pobrania (uint), numerując od 0
size = Rozmiar porcji (uint)

Zwracane wartości:

Dla każdej z funkcji (array):
id Identyfikator funkcji (nie numer w porcji), której dane pobieramy (uint)
=> Dane dotyczące funkcji (array), patrz: ask=funkcja&id



Przykład:

Przykład prostej implementacji w jQuery, pobierający liczbę funkcji w Dokumentacji:
jQuery(function($){
	$.ajax({
		'url':		'http://api.amxx.pl/gate.php?ask=funkcja&count&format=jsonp&callback=log_functions',
		'dataType':	'jsonp',
		'jsonp':	'log_functions',
	});
});

function log_functions(response){
	console.log('W Dokumentacji AMXX.pl znajduje się '+response['data']+' funkcji.');
}
W Dokumentacji AMXX.pl znajduje się 2036 funkcji.


Adreshttp://api.amxx.pl/gate.php?ask=modul

id
Pobiera dane modułu o podanym identyfikatorze.

id = Identyfikator modułu do pobrania (uint)

Zwracane wartości:

Informacje o modułu (array):
name => Nazwa modułu (string)
desc => Opis modułu (HTML)
sids => Identyfikatory sekcji należących do modułu oddzielane przecinkami (/(\d+(,\d+)*)?/)

Przykład:

ids
Pobiera dane modułu o podanych identyfikatorach.

ids = Identyfikatory modułu do pobrania oddzielane przecinkami (/\d+(,\d+)*/)

Zwracane wartości:

Dla każdej z modułu (array):
id Identyfikator modułu, której dane pobieramy (uint)
=> Dane dotyczące modułu (array), patrz: ask=modul&id



Przykład:

all
Pobiera dane wszystkich modułu.

Zwracane wartości:

Dla każdej z modułu (array):
id Identyfikator modułu, której dane pobieramy (uint)
=> Dane dotyczące modułu (array), patrz: ask=modul&id



count
Zwraca liczbę wszystkich modułu.

Zwracane wartości:

count Liczba wszystkich modułu (uint)


Przykład:

newest
Zwraca identyfikator najnowszej modułu.

Zwracane wartości:

newest Identyfikator najnowszej modułu (uint)


Przykład:

part
Pobiera wybraną porcję size modułu: LIMIT(size * part, size)
part = Identyfikator porcji modułu do pobrania (uint), numerując od 0
size = Rozmiar porcji (uint)

Zwracane wartości:

Dla każdej z modułu (array):
id Identyfikator modułu (nie numer w porcji), której dane pobieramy (uint)
=> Dane dotyczące modułu (array), patrz: ask=modul&id



Przykład:

Adreshttp://api.amxx.pl/gate.php?ask=sekcja

id
Pobiera dane sekcji o podanym identyfikatorze.

id = Identyfikator sekcji do pobrania (uint)

Zwracane wartości:

Informacje o sekcji (array):
mid => Identyfikator modułu, do którego należy sekcja (uint)
name => Nazwa sekcji (string)
desc => Opis sekcji (HTML)
fids => Identyfikatory funkcji należących do sekcji oddzielane przecinkami (/(\d+(,\d+)*)?/)

Przykład:

ids
Pobiera dane sekcji o podanych identyfikatorach.

ids = Identyfikatory sekcji do pobrania oddzielane przecinkami (/\d+(,\d+)*/)

Zwracane wartości:

Dla każdej z sekcji (array):
id Identyfikator sekcji, której dane pobieramy (uint)
=> Dane dotyczące sekcji (array), patrz: ask=sekcja&id



Przykład:

all
Pobiera dane wszystkich sekcji.

Zwracane wartości:

Dla każdej z sekcji (array):
id Identyfikator sekcji, której dane pobieramy (uint)
=> Dane dotyczące sekcji (array), patrz: ask=sekcja&id



count
Zwraca liczbę wszystkich sekcji.

Zwracane wartości:

count Liczba wszystkich sekcji (uint)


Przykład:

newest
Zwraca identyfikator najnowszej sekcji.

Zwracane wartości:

newest Identyfikator najnowszej sekcji (uint)


Przykład:

part
Pobiera wybraną porcję size sekcji: LIMIT(size * part, size)
part = Identyfikator porcji sekcji do pobrania (uint), numerując od 0
size = Rozmiar porcji (uint)

Zwracane wartości:

Dla każdej z sekcji (array):
id Identyfikator sekcji (nie numer w porcji), której dane pobieramy (uint)
=> Dane dotyczące sekcji (array), patrz: ask=sekcja&id



Przykład:

Adreshttp://api.amxx.pl/gate.php?ask=doku_stats

last_edit
Pobiera czas ostatniej edycji w Dokumentacji.

Zwracane wartości:

last_edit Data ostatniej edycji (unix time)


Przykład: