Solicitudes de construcción
Las solicitudes se componen de tres componentes:
- versión de la API
- Ruta de recursos
- Tipo de salida
Para construir una solicitud adecuada, deberá formatear el URI de la siguiente manera:
https://api.yourepo.com/{version}/{resource}.{output_type}
Una solicitud de ejemplo, para obtener una lista de miembros que compraron un paquete.
https://api.yourepo.com/1.0/package/buyers.json?package=com.yourepo.source.package
De forma predeterminada, las solicitudes son solicitudes HTTP GET. Sin embargo, muchos métodos requerirán que envíe datos POST. Por lo general, seguiremos el estándar de que todas las solicitudes de lectura usen GET y las solicitudes de escritura usen POST.
Además de los parámetros necesarios para cada método individual, también deberá enviar su clave API.
Si está utilizando la API del lado del servidor, deberá enviar secret_key con el valor de su clave de API secreta.
versión de la API
Para cada solicitud, debe especificar qué versión de la API desea utilizar. Actualmente, la versión predeterminada y la única disponible es 1.0.
Ruta de recursos
La ruta del recurso está disponible para usted en documentación adicional.
Formatos de datos
YouRepo only supports one data format currently, JSON.
Respuestas
La respuesta a su solicitud contendrá varias cosas clave:
- Código de estado HTTP
- Estado de la API
code - mensaje de respuesta de la API
Tomemos una solicitud de ejemplo:
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"
},
.....
]
}
}