Identifier l’interface à évaluer.
Choisissez une interface pour votre cas d’usage, examinez les contrats applicatifs sélectionnés et exécutez le kit d’intégration synthétique téléchargeable.
Quatre interfaces distinctes
Une route HTTP existante ne devient pas automatiquement un produit partenaire pris en charge. Les routes de session applicative ci-dessous servent les parcours autorisés de Peyeli. Un contrat serveur à serveur nécessite des décisions distinctes d’authentification, périmètre, version, support et validation avant partage d’identifiants.
| Interface | Usage actuel | Limite partenaire |
|---|---|---|
| Documentation publique | Lire guides et exemples synthétiques sans compte. | Aucun accès aux documents ni exécution. |
| API de session applicative | Utilisateur vérifié et permissions actuelles de l’organisation. | Parcours utilisateur/tenant approuvé uniquement ; aucune clé développeur promise. |
| Protocoles fournisseurs | Adaptateurs approuvés, preuves entrantes authentifiées et retours autorisés. | Identifiants et accords propres au programme ; aucun appelant arbitraire. |
| Opérations privilégiées | Administration, ordonnanceur, diagnostics et gouvernance. | Pas une interface partenaire ; aucun accès par défaut. |
Catalogue applicatif sélectionné
Les chemins contiennent des variables, pas des identifiants valides. Les exemples sont documentaires. Ce catalogue sélectionné n’autorise aucun appel et n’énumère pas les points d’accès privilégiés.
| Méthode / chemin | Opération | Réussite |
|---|---|---|
| GET /api/v1/orgs/{org}/payment-intents | payment.view ; liste limitée. | 200 { data: IntentView[] } |
| POST /api/v1/orgs/{org}/payment-intents | payment.create ; création idempotente. | 201 IntentView |
| GET /api/v1/orgs/{org}/payment-intents/{pi} | payment.view ; contrôle du document. | 200 IntentView + attempts + receipt |
| POST /api/v1/orgs/{org}/payment-intents/{pi}/attempts | payment.collect ; contrôle des capacités fournisseur. | 201 { attemptId, providerReference } |
| POST /api/v1/orgs/{org}/payment-intents/{pi}/cancel | payment.cancel ; tentatives non résolues bloquantes. | 200 IntentView |
| GET /api/v1/orgs/{org}/invoices | invoice.view ; filtre de statut. | 200 { data, canCredit } |
| GET /api/v1/orgs/{org}/reconciliation/{day} | exception.view ; preuves de journée commerciale. | 200 { day, totals, pairs, lastImport } |
| GET /api/v1/orgs/{org}/exports/payments.csv | export.csv ; droit du forfait également possible. | 200 pièce jointe text/csv |
Définir le domaine, pas toute l’arborescence.
Le code contient aussi catalogue/commandes, clients/factures, dépenses/fichiers bancaires, abonnements, comptabilité, planification personnelle et parcours financiers approuvés. Un partenaire peut n’avoir besoin que d’un domaine. Sélectionner documents et opérations ; un domaine ne prouve ni API externe ni disponibilité en production.
| Relation | Périmètre à examiner |
|---|---|
| Entreprise marchande / institution | Commandes, factures, clients, documents, exports et responsabilités utilisateurs/agences. |
| Logiciel / comptabilité / analyse | Documents autorisés, correspondances, lecture/écriture, synchronisation et déconnexion. |
| Distribution / écosystème | Public, inscription, marque, support et attribution ; aucun mouvement de fonds par défaut. |
| Institution / fournisseur financier | Seulement programme approuvé de collecte, règlement, transfert, garde ou émission. |
| Intégration de produit personnel | Documents personnels et échange autorisé ; aucun héritage des rôles marchands. |
Avant une intégration externe prise en charge
La revue doit approuver points d’accès, environnement, authentification, restrictions opération/tenant, reprise, quotas, version de schéma et dépréciation. Ce dossier ne publie ni quota universel, ni SDK partenaire officiel, ni catalogue OAuth partenaire, ni abonnement aux événements sortants, ni clés en libre-service. Un préfixe versionné ne garantit pas ces éléments.
Télécharger, exécuter et examiner le kit.
Le kit contient OpenAPI 3.1 pour cinq opérations sélectionnées, une collection Postman, un SDK JavaScript avec déclarations TypeScript et un simulateur synthétique sans dépendance. Exécuter node example.mjs en mémoire ou node server.mjs pour un serveur HTTP local. Aucun compte, clé, fournisseur ou serveur de production fourni.
Le simulateur écoute uniquement 127.0.0.1:3061, conserve les données synthétiques en mémoire et ne contacte aucun fournisseur. Il démontre montants entiers, rejeu/conflit idempotent, lecture/liste, soumission et annulation. Les tentatives restent en traitement : aucune confirmation financière, solde réglé ou reçu inventé. Il ne valide pas authentification, isolation, reprise durable, canaux financiers ou fournisseurs réels. Les dates utilisent UTC synthétique, distinct du prédicat applicatif.
node example.mjs
# Or start the local HTTP mock, then import partner-postman.json:
node server.mjsLe contrat JSON sélectionné.
Schémas des entrées/sorties et opérations sélectionnées. Documentaire ; aucun appel ni identifiant.
Le kit d’intégration.
OpenAPI, Postman, SDK JavaScript avec déclarations TypeScript et serveur de test local. Aucun fournisseur ni fonds réels.