Opmerking: u bevindt zich in het gedeelte voor geavanceerde gebruikers. Gebruik deze sectie alleen als u bekend bent met API's.
Onze openbare API biedt toegang tot alle inhoud van de openbare kennisbank, zoals vragen en categorieën.
Gebruik de volgende URL om vragen te krijgen:
my_account.helpjuice.com/api/questions
U kunt de geretourneerde vragen verder filteren en ordenen via Queryparameters:
| Parameter |
Omschrijving |
Type |
Standaard |
| categorie ID |
Retourneert alleen vragen onder deze categorie. |
Rond getal |
nul |
| grens |
Beperkt het aantal teruggestuurde vragen. De maximale limiet is 1000. Als u al uw records nodig heeft, moet u deze parameter gebruiken in combinatie met page. |
Rond getal |
250 |
| bladzijde | Handig om vragen in stukjes te verzamelen. | Rond getal | 1 |
| bestellen |
Bestel de vragen om te retourneren. Toegestaan: "naam" en "updated_at". |
Draad |
positie |
| segmenten [sleutel] | Geeft vragen weer met de opgegeven segmentatievelden. Deze optie accepteert meerdere parameters met verschillende sleutels, waardoor meerdere segmentatievelden kunnen worden gespecificeerd. Voorbeeld: "/? Segmenten [merk] = helpjuice & segmenten [naam] = vragen" | Draad | nul |
| gerelateerd aan | Geeft alleen vragen terug die betrekking hebben op de geparameteriseerde vraag. |
Rond getal | nul |
Het is ook mogelijk om de vragen in een specifieke taal te plaatsen. Om dit te doen, specificeert u eenvoudig de gewenste taal in de URL met behulp van de volgende syntaxis:
my_account.helpjuice.com/api/en_US/questions
Reactie:
[
{
"id": 112828,
"name": "Sluit video's in uw kennisbank in",
bekeken: 394,
"account_id": 1885,
"toegankelijkheid": 1,
"description": null,
"email": "john.smith@example.com",
"is_published": waar,
"is_juiced": false,
"codename": "embedding-videos-into-knowledge-base",
"language_id": 1,
"positie": 0,
"created_at": "2014-11-24T20: 15: 53.865Z",
"updated_at": "2016-01-23T17: 00: 51.389Z",
"categorieën": [
{
"id": 7732,
"account_id": 1885,
"name": "Gebruik onze teksteditor",
"language_id": 1,
"toegankelijkheid": 1,
"created_at": "2014-11-19T16: 30: 44.994Z",
"updated_at": "2016-03-10T14: 58: 21.011Z",
"parent_id": 7728,
"lft": 10312,
"rgt": 10313,
"positie": 3,
"codename": "met onze teksteditor",
"index": 0
}]
}
]Standaard worden vragen weergegeven in JSON-indeling. Het is echter mogelijk om ze op te halen in 2 andere formaten: XLS en CSV. Om dit te doen, hoeft u alleen het formaat in de URL op te geven, als volgt:
my_account.helpjuice.com/api/questions.xls => om een XLS-spreadsheet te krijgen
my_account.helpjuice.com/api/questions.csv => om een CSV-bestand te krijgen
Het probleem oplossen
- Blanco antwoord : Als u geen gegevens ziet, of als u een beschadigd bestand ontvangt (in het geval van XLS), komt dat doordat uw kennisbank alleen als intern is gemarkeerd. Oplossing: als u een browser gebruikt om toegang te krijgen tot de gegevens, log dan in voordat u het verzoek doet. Anders moet u uw private key (toegankelijk via Instellingen> API-referentie) te gebruiken in een verzoek parameter genaamd api_key, zoals:
- my_account.helpjuice.com/api/en_US/questions?api_key= MY_KEY
