DOCUMENTATION DE L'API

Authentification et clés

Clés porteuses, portées, deux environnements, et comment un espace de travail accède à la production.

Envoyez la clé comme jeton porteur : Authorization: Bearer tp_live_… ou tp_test_…. TaxPio ne conserve qu'un hachage et les quatorze premiers caractères; une clé perdue est remplacée, jamais récupérée. Les clés expirent selon le calendrier choisi à leur création (30, 90 ou 365 jours, ou jamais) et peuvent être révoquées immédiatement depuis la console.

PortéeAccorde
calculations:readLire les calculs
calculations:writeExécuter des calculs
connections:manageInviter, énumérer et terminer les connexions aux profils des clients
records:importEnvoyer des dossiers dans les profils connectés
records:readRelire les dossiers qu'elle a envoyés
documents:readLire les documents
documents:writeTéléverser des documents
webhooks:manageGérer les webhooks
usage:readLire l'utilisation et les crédits

Environnements

Une clé de bac à sable (tp_test_…) exécute les mêmes ensembles de règles avec le même moteur, sans aucun lien vers un système gouvernemental, et n'est jamais facturée. Une clé réelle (tp_live_…) est créée seulement après que l'espace de travail a réussi l'examen de production : TaxPio examine le cas d'utilisation, la sécurité et l'accès à la production avant d'activer les portées réelles. Les opérations réservées au bac à sable répondent 403 SANDBOX_ONLY à une clé réelle; les opérations liées au gouvernement répondent 403 LIVE_ONLY à une clé de bac à sable.

Limites de débit

EnvironnementDemandes par minute par clé
live600
sandbox120

Chaque réponse porte x-ratelimit-limit, x-ratelimit-remaining et x-ratelimit-reset. Au-delà de la limite, l'API répond 429 RATE_LIMITED avec retry-after en secondes; le compteur se remplit en continu.

Refusé
HTTP/1.1 401 Unauthorized
WWW-Authenticate: Bearer realm="api.taxpio.com"

{ "error": "The API key is not recognised.", "code": "API_KEY_INVALID", "requestId": "…", "docs_url": "https://docs.taxpio.com/errors#api-key-invalid" }