Κάνοντας αιτήματα

Αιτήματα κατασκευής

Τα αιτήματα αποτελούνται από τρία στοιχεία:

• Έκδοση API
• Διαδρομή πόρων
• Τύπος εξόδου

Για να δημιουργήσετε ένα σωστό αίτημα, θα χρειαστεί να μορφοποιήσετε το URI ως εξής:

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

Ένα παράδειγμα αιτήματος, για τη λήψη μιας λίστας μελών που έχουν αγοράσει ένα πακέτο.

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

Από προεπιλογή, τα αιτήματα είναι αιτήματα HTTP GET. Ωστόσο, πολλές μέθοδοι θα απαιτήσουν από εσάς να στείλετε δεδομένα POST. Συνήθως, θα ακολουθούμε το πρότυπο όλων των αιτημάτων ανάγνωσης που χρησιμοποιούν το GET και τα αιτήματα εγγραφής χρησιμοποιούν το POST.

Εκτός από τις απαιτούμενες παραμέτρους για κάθε μεμονωμένη μέθοδο, θα χρειαστεί επίσης να στείλετε το κλειδί API σας.

Εάν χρησιμοποιείτε το API από την πλευρά του διακομιστή, θα πρέπει να στείλετε το secret_key με την τιμή του μυστικού κλειδιού API.

Έκδοση API

Για κάθε αίτημα θα πρέπει να καθορίσετε ποια έκδοση του API θέλετε να χρησιμοποιήσετε. Επί του παρόντος, η προεπιλογή και η μόνη διαθέσιμη έκδοση είναι η 1.0.

Διαδρομή πόρων

Η διαδρομή πόρων είναι διαθέσιμη σε περαιτέρω τεκμηρίωση.

Μορφές δεδομένων

YouRepo only supports one data format currently, JSON.

Απαντήσεις

Η απάντηση του αιτήματός σας θα περιέχει πολλά βασικά πράγματα:

• Κωδικός κατάστασης HTTP
• Κατάσταση API κωδικός
• Μήνυμα απάντησης API

Ας πάρουμε ένα παράδειγμα αιτήματος:

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