Richieste di costruzione
Le richieste sono composte da tre componenti:
- Versione API
- Percorso delle risorse
- Tipo di uscita
Per costruire una richiesta corretta, dovrai formattare l'URI come segue:
https://api.yourepo.com/{version}/{resource}.{output_type}
Una richiesta di esempio, per recuperare un elenco di membri che hanno acquistato un pacchetto.
https://api.yourepo.com/1.0/package/buyers.json?package=com.yourepo.source.package
Per impostazione predefinita, le richieste sono richieste HTTP GET. Tuttavia, molti metodi richiedono l'invio di dati POST. In genere, seguiremo lo standard di tutte le richieste di lettura utilizzano GET e le richieste di scrittura utilizzano POST.
Oltre ai parametri richiesti per ogni singolo metodo, dovrai inviare anche la tua chiave API.
Se stai utilizzando l'API lato server, dovrai inviare secret_key
con il valore della tua chiave API segreta.
Versione API
Per ogni richiesta è necessario specificare quale versione dell'API si desidera utilizzare. Attualmente, l'impostazione predefinita e l'unica versione disponibile è 1.0.
Percorso delle risorse
Il percorso della risorsa è reso disponibile in ulteriore documentazione.
Formati di dati
YouRepo only supports one data format currently, JSON.
Risposte
La risposta alla tua richiesta conterrà diversi elementi chiave:
- Codice di stato HTTP
- Stato API
codice
- Messaggio di risposta dell'API
Prendiamo una richiesta di esempio:
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" }, ..... ] } }