Gjøre forespørsler

Oppsett av forespørsler

Forespørsler består av tre deler:

  • API-versjon
  • Ressursbane
  • Utdatatype

For å lage en skikkelig forespørsel, må du sette opp URI-en som følger:

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

En eksempelforespørsel for å motta lista over medlemmer som har kjøpt ei pakke.

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

Som standard bruker HTTP-forespørsler GET-metoden, men ofte kreves det at POST-metoden brukes isteden. Vi følger helst skikken om å bruke GET til forespørsler om å motta data, og POST til forespørsler om å sende data.

I tillegg til de påkrevde parameterne til de individuelle metodene, må du også sende API-nøkkelen din.

Om du bruker det tjener-baserte API-et, må du sende med den private nøkkelen din i secret_key-feltet.

API-versjon

For hver forespørsel bør du angi API-versjonen du vil bruke. For øyeblikket er 1.0 standard og den eneste tilgjengelige.

Ressursbane

Ressursbanen gjøres tilgjengelig for deg i videre dokumentasjon.

Dataformater

YouRepo støtter bare ett format for øyeblikket, JSON.

Svar

Svaret på forespørselen din inneholder flere viktige ting:

  • HTTP-tilstandsnummer
  • API-tilstandskode: code
  • API-svarmelding

La oss se på et eksempel på forespørsel:

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