Opmerking: u bevindt zich in het gedeelte voor geavanceerde gebruikers. Gebruik deze sectie alleen als u bekend bent met API's.
Gebruik de volgende URL om categorieën op te halen:
my_account.helpjuice.com/api/categories
U kunt de categorieën die worden geretourneerd door Queryparameters verder filteren en ordenen:
| Parameter | Omschrijving | Type | Standaard |
| ouder ID |
Retourneert alleen vragen onder deze categorie. | Rond getal | nul |
| bestellen | Bestelt de geretourneerde categorieën. Toegestaan: "naam", "updated_at" en "created_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] = categorieën" |
Draad | nul |
Het is ook mogelijk om de categorieën binnen een specifieke taal te ordenen. 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/categories
Reactie:
[
{
"id": 7730,
"name": "Ontwerp uw kennisbank",
"codename": "designing-your-knowledge-base",
"parent_id": null,
"created_at": "2014-11-19T16: 30: 03.676Z",
"updated_at": "2016-02-11T20: 15: 42.718Z"
}, {
"id": 7729,
"name": "Algemene vragen",
"codename": "algemene vragen",
"parent_id": null,
"created_at": "2014-11-19T16: 29: 56.223Z",
"updated_at": "2016-02-11T20: 15: 42.718Z"
}
]Standaard worden categorieën 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/categories.xls => om een XLS-spreadsheet te krijgen
my_account.helpjuice.com/api/categories.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 indient. 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
