Anfragen machen

Anfragen konstruieren

Anfragen bestehen aus drei Komponenten:

  • API-Version
  • Ressourcenpfad
  • Ausgabetyp

Um eine ordnungsgemäße Anfrage zu erstellen, müssen Sie den URI wie folgt formatieren:

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

Eine Beispielanfrage, um eine Liste von Mitgliedern abzurufen, die ein Paket gekauft haben.

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

Standardmäßig sind Anforderungen HTTP GET-Anforderungen. Bei vielen Methoden müssen Sie jedoch POST-Daten senden. Normalerweise folgen wir dem Standard, dass alle Leseanforderungen GET und Schreibanforderungen POST verwenden.

Zusätzlich zu den erforderlichen Parametern für jede einzelne Methode müssen Sie auch Ihren API-Schlüssel senden.

Wenn Sie die serverseitige API verwenden, müssen Sie secret_key mit Ihrem geheimen API-Schlüsselwert senden.

API-Version

Für jede Anfrage sollten Sie angeben, welche Version der API Sie verwenden möchten. Derzeit ist die Standardversion und die einzige verfügbare Version 1.0.

Ressourcenpfad

Der Ressourcenpfad wird Ihnen in weiterer Dokumentation zur Verfügung gestellt.

Datenformate

YouRepo only supports one data format currently, JSON.

Antworten

Die Antwort auf Ihre Anfrage enthält mehrere wichtige Dinge:

  • HTTP-Statuscode
  • API-Status code
  • API-Antwortnachricht

Nehmen wir eine Beispielanfrage:

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"
			},
			.....
		]
	}
}