Bibliothèques clientes et Postman

Chaque opération de la référence de l’API REST est une méthode des clients officiels. Les tables de méthodes sont générées depuis le même document OpenAPI que la référence : un nouvel endpoint arrive donc dans les trois bibliothèques en même temps. Les clients envoient votre token d’API comme bearer token, réessaient 429 et 503 après Retry-After, lèvent une erreur avec le problem detail de l’API et parcourent les collections pour vous. Ils n’ont aucune dépendance au-delà de la bibliothèque standard du langage.

Les appels prennent un seul ensemble de paramètres : paramètres de chemin (id), body (le corps JSON de la requête) et tout paramètre de requête.

PHP

composer require helpfalcon/helpfalcon-php

$client = new HelpFalcon\Client('https://acme.example.com', getenv('HELPFALCON_TOKEN'));

$ticket = $client->tickets->create(['body' => ['subject' => 'Printer on fire', 'description' => 'Help']]);
$client->tickets->update(['id' => $ticket['id'], 'body' => ['status' => 'pending']]);

foreach ($client->paginate($client->tickets->list(...), ['status' => 'open']) as $open) {
    echo $open['subject'], PHP_EOL;
}

Node.js

npm install @helpfalcon/api

import { HelpFalcon } from "@helpfalcon/api";

const client = new HelpFalcon({ baseUrl: "https://acme.example.com", token: process.env.HELPFALCON_TOKEN });

const ticket = await client.tickets.create({ body: { subject: "Printer on fire", description: "Help" } });
await client.tickets.update({ id: ticket.id, body: { status: "pending" } });

for await (const open of client.paginate(client.tickets.list, { status: "open" })) {
  console.log(open.subject);
}

Les types TypeScript de chaque ressource et méthode sont fournis avec le paquet.

Python

pip install helpfalcon

from helpfalcon import HelpFalcon

client = HelpFalcon("https://acme.example.com", token=os.environ["HELPFALCON_TOKEN"])

ticket = client.tickets.create(body={"subject": "Printer on fire", "description": "Help"})
client.tickets.update(id=ticket["id"], body={"status": "pending"})

for open_ticket in client.paginate(client.tickets.list, status="open"):
    print(open_ticket["subject"])

L’API compatible Zendesk

Chaque client a aussi une méthode request brute pour n’importe quel chemin, y compris l’API compatible Zendesk :

await client.request("GET", "/zd/api/v2/tickets.json", { query: { per_page: 100 } });

Postman

Importez clients/postman/helpfalcon.postman_collection.json depuis le dépôt. Définissez les variables de collection baseUrl (votre espace de travail) et token (un token d’API de Admin Center, Integrations, API tokens). Les requêtes sont regroupées par ressource.

Modifications

Ce qui a changé dans l’API, version par version, figure dans le journal des modifications de l’API.