Suivi des recettes et dépenses API

Suivi des recettes et dépenses API, Livre Recettes-Dépenses gère ses enregistrements depuis votre propre application : lister, ajouter, modifier et supprimer. Les points de terminaison fonctionnent avec une clé API au lieu d'une session de navigateur.

Démarrage rapide

Créez une clé dans la section API Développeur de votre compte ; la clé en texte brut n'est affichée qu'au moment de sa création.
Envoyez la requête à https://api.pixepi.com avec l'en-tête Authorization: Bearer <key>.
Les réponses renvoient du JSON ; sur les points de terminaison de liste, vous pouvez utiliser page, per_page et les champs de filtrage.

Exemple de requête

curl -H "Authorization: Bearer $PIXEPI_KEY" "https://api.pixepi.com/api/v1/apps/gelir-gider-defteri/categories"

curl -X POST "https://api.pixepi.com/api/v1/apps/gelir-gider-defteri/categories" \
  -H "Authorization: Bearer $PIXEPI_KEY" \
  -d "kind=expense" \
  -d "name=Loyer"

Points de terminaison de cet outil

Méthode	Chemin	Description
`GET`	`/categories`	Liste les catégories (catégories système partagées et catégories personnelles).
`POST`	`/categories`	Ajoute une nouvelle catégorie.
`POST`	`/categories/{id}`	Met à jour une catégorie.
`POST`	`/categories/{id}/archive`	Archive une catégorie ; un nouvel appel ne modifie pas le statut.
`GET`	`/entries`	Liste les écritures ; filtre par date, type, catégorie et note.
`POST`	`/entries`	Ajoute une nouvelle écriture.
`POST`	`/entries/{id}`	Met à jour une écriture.
`POST`	`/entries/{id}/delete`	Supprime une écriture.
`GET`	`/summary`	Répartition récapitulative : par mois, catégorie ou type.
`GET`	`/export.csv`	Exporte les écritures au format CSV.

Points de terminaison partagés

Méthode	Chemin	Description
`GET`	`/api/v1/apps`	Catalogue d'API
`GET`	`/api/v1/apps/gelir-gider-defteri`	Spécification de l'outil
`GET`	`/api/v1/usage`	Résumé d'utilisation
`GET`	`/api/v1/openapi.json`	Document OpenAPI 3.1

Limites

Le champ limit des réponses de liste fournit les informations d'utilisation et de plafond.
Les quotas et les informations d'abonnement sont rattachés à votre compte ; vérifiez l'état actuel avec GET /api/v1/usage.

Codes d'erreur

Code	Signification
`unauthorized`	La clé d'API est manquante ou invalide.
`forbidden`	Cette opération n'est pas autorisée avec cette clé.
`not_found`	Outil, tâche ou enregistrement introuvable (404 également pour accès inter-comptes).
`invalid_input`	Échec de validation des données saisies (champ manquant ou mal formé, date invalide, etc.).
`invalid_request`	La requête est mal formée.
`too_large`	La taille du fichier ou du corps dépasse la limite autorisée.
`unsupported_media`	Ce type de fichier n'est pas accepté.
`not_supported`	Cet outil ne peut pas fonctionner sur ce point de terminaison (application avec état).
`not_ready`	La tâche n'est pas encore terminée.
`expired`	Le fichier généré a expiré.
`no_output`	Aucun fichier à télécharger pour cette tâche.
`invalid_path`	Chemin de sortie invalide.
`quota_exceeded`	Quota ou limite de requêtes dépassé.
`rate_limited`	Trop de requêtes en peu de temps ; veuillez patienter avant de réessayer.
`csrf`	Échec de la vérification du formulaire de navigation (l'API externe utilise des clés).
`conflict`	L'opération entre en conflit avec l'état actuel.
`unavailable`	L'outil est temporairement indisponible.
`internal_error`	Erreur interne du serveur inattendue.

Documents

Foire aux questions

Comment obtenir une clé API ?

Créez une clé dans la section API Développeur de votre compte ; la clé n'est affichée qu'une seule fois, au moment de sa création.

Comment envoyer une requête ?

Les points de terminaison fonctionnent sur https://api.pixepi.com ; chaque requête doit inclure l'en-tête "Authorization: Bearer <clé>".

Quels points de terminaison l'API Livre Recettes-Dépenses propose-t-elle ?

Le tableau ci-dessus répertorie les points de terminaison disponibles ; ils fonctionnent tous avec les enregistrements associés à votre compte et renvoient une erreur 404 en cas d'accès inter-comptes.

Comment interpréter une réponse d'erreur ?

Le corps de l'erreur contient les champs {ok:false, error, code, request_id} ; les valeurs des codes figurent dans le tableau des codes d'erreur.