Napomena: Nalazite se u odjeljku za napredne korisnike. Koristite ovaj odjeljak samo ako ste upoznati s API-ima.
Naš javni API omogućava pristup svim sadržajima javne baze znanja, poput pitanja i kategorija.
Koristite sljedeći URL da biste dobili pitanja:
my_account.helpjuice.com/api/questions
Vraćena pitanja možete dalje filtrirati i organizirati putem parametara upita:
| Parametar |
Opis |
Tip |
Standard |
| ID kategorije |
Vraća samo pitanja iz ove kategorije. |
Okrugli broj |
nula |
| granica |
Ograničava broj vraćenih pitanja. Maksimalno ograničenje je 1000. Ako su vam potrebni svi vaši zapisi, morate koristiti ovaj parametar zajedno sa stranicom. |
Okrugli broj |
250 |
| stranica | Praktično za prikupljanje pitanja u komadima. | Okrugli broj | 1 |
| naručiti |
Naredite da se pitanja vrate. Dozvoljeno: "ime" i "updated_at". |
Žica |
pozicija |
| segmenti [ključ] | Prikazuje pitanja sa navedenim poljima segmentacije. Ova opcija prihvaća više parametara s različitim ključevima, omogućavajući specificiranje više polja segmentacije. Primjer: "/? Segmenti [brand] = helpjuice & segmenti [ime] = pitanja" | Žica | nula |
| vezano za | Vraća samo pitanja u vezi s parametriziranim pitanjem. |
Okrugli broj | nula |
Također je moguće smjestiti pitanja na određeni jezik. Da biste to učinili, jednostavno navedite željeni jezik u URL-u koristeći sljedeću sintaksu:
my_account.helpjuice.com/api/en_US/questions
Odgovor:
[
{
"id": 112828,
"name": "Ugradite video zapise u svoju bazu znanja",
pregleda: 394,
"account_id": 1885,
"pristupačnost": 1,
"opis": null,
"email": "john.smith@example.com",
"is_published": tačno,
"is_juiced": netačno,
"kodno ime": "ugrađivanje-videozapisa u bazu znanja",
"language_id": 1,
"pozicija": 0,
"created_at": "2014-11-24T20: 15: 53.865Z",
"updated_at": "2016-01-23T17: 00: 51.389Z",
"kategorije": [
{
"id": 7732,
"account_id": 1885,
"name": "Koristite naš uređivač teksta",
"language_id": 1,
"pristupačnost": 1,
"created_at": "2014-11-19T16: 30: 44.994Z",
"updated_at": "2016-03-10T14: 58: 21.011Z",
"parent_id": 7728,
"lft": 10312,
"rgt": 10313,
"pozicija": 3,
"codename": "pomoću našeg uređivača teksta",
"indeks": 0
}]
}
]Pitanja su prema zadanim postavkama prikazana u JSON formatu. Međutim, moguće ih je preuzeti u 2 druga formata: XLS i CSV. Da biste to učinili, samo trebate navesti format u URL-u, kako slijedi:
my_account.helpjuice.com/api/questions.xls => za dobivanje XLS proračunske tablice
my_account.helpjuice.com/api/questions.csv => da biste dobili CSV datoteku
Riješite problem
- Prazan odgovor : Ako ne vidite nikakve podatke ili ako primite oštećenu datoteku (u slučaju XLS-a), to je zato što je vaša baza znanja označena samo kao interna . Rješenje: Ako za pristup podacima koristite pregledač, prijavite se prije podnošenja zahtjeva. U suprotnom, morate koristiti svoj privatni ključ (kojem se može pristupiti iz Postavke> API vjerodajnice) u parametru zahtjeva zvanom api_key , kao što je:
- my_account.helpjuice.com/api/en_US/questions?api_key= MY_KEY
