Składanie wniosków

Konstruowanie wniosków

Prośby składają się z trzech elementów:

• Wersja API
• Ścieżka zasobów
• Typ wyjścia

Aby skonstruować prawidłowe żądanie, musisz sformatować identyfikator URI w następujący sposób:

https://api.yourepo.com/{version}/{resource}.{output_type}

Przykładowa prośba o pobranie listy członków, którzy kupili pakiet.

https://api.yourepo.com/1.0/package/buyers.json?package=com.yourepo.source.package

Domyślnie żądania są żądaniami HTTP GET. Jednak wiele metod wymaga wysłania danych POST. Zazwyczaj będziemy postępować zgodnie ze standardem, w którym wszystkie żądania odczytu używają GET, a żądania zapisu używają POST.

Oprócz wymaganych parametrów dla każdej indywidualnej metody będziesz musiał również wysłać swój klucz API.

Jeśli używasz API po stronie serwera, musisz wysłać secret_key z wartością tajnego klucza API.

Wersja API

Dla każdego żądania należy określić, której wersji API chcesz użyć. Obecnie domyślną i jedyną dostępną wersją jest 1.0.

Ścieżka zasobów

Ścieżka zasobów jest udostępniana w dalszej dokumentacji.

Formaty danych

YouRepo only supports one data format currently, JSON.

Odpowiedzi

Odpowiedź na Twoje zapytanie będzie zawierać kilka kluczowych rzeczy:

• Kod stanu HTTP
• Stan API kod
• Wiadomość z odpowiedzią API

Weźmy przykładowe żądanie:

GET https://api.yourepo.com/1.0/package/buyers?package=com.yourepo.source.package&secret_key=YOUR_SECRET_KEY

{
	"code": 0,
	"response": {
		"start": 0,
		"limit": 25,
		"total": "62",
		"page": 1,
		"buyers": [
			{
				"nickname": "member1",
				"status": "Completed",
				"profile_url": "https:\/\/www.yourepo.com\/forum\/profile\/member1"
			},
			{
				"nickname": "member2",
				"status": "Completed",
				"profile_url": "https:\/\/www.yourepo.com\/forum\/profile\/member2"
			},
			.....
		]
	}
}