Construindo Solicitações
As solicitações são feitas de três componentes:
- Versão da API
- Caminho do recurso
- Tipo de saída
Para construir uma solicitação adequada, você precisará formatar o URI da seguinte maneira:
https://api.yourepo.com/{version}/{resource}.{output_type}
Um exemplo de solicitação para buscar uma lista de membros que compraram um pacote.
https://api.yourepo.com/1.0/package/buyers.json?package=com.yourepo.source.package
Por padrão, as solicitações são solicitações HTTP GET. No entanto, muitos métodos exigirão que você envie dados POST. Normalmente, seguiremos o padrão de todas as solicitações de leitura usarem GET e solicitações de gravação usarão POST.
Além dos parâmetros necessários para cada método individual, você também precisará enviar sua chave de API.
Se você estiver usando a API do lado do servidor, precisará enviar secret_key com o valor da chave de API secreta.
Versão da API
Para cada solicitação, você deve especificar qual versão da API deseja usar. Atualmente, o padrão e a única versão disponível é 1.0.
Caminho do recurso
O caminho do recurso é disponibilizado para você em documentação adicional.
Formatos de dados
YouRepo only supports one data format currently, JSON.
Respostas
A resposta da sua solicitação conterá várias coisas importantes:
- Código de status HTTP
- Status da API
código - Mensagem de resposta da API
Vamos dar um exemplo de solicitação:
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"
},
.....
]
}
}