Reference API

Reference API

Reference interactive des endpoints partenaires: creation de contrat, suivi de statut et configuration webhook.

Ce que tu peux faire ici

Cette section regroupe les endpoints metier exposes aux partenaires avec une reference interactive basee sur la spec OpenAPI reelle.

Si tu arrives ici pour un premier test, commence par Authentification, puis ouvre Créer une demande de contrat. La reference retournee servira ensuite a suivre tout le cycle de vie du contrat.

Playground

Actif

Test direct des endpoints depuis la documentation.

Source

Swagger live

La reference est synchronisee depuis la spec de l API Nest.

Auth

API key / JWT

Les appels partenaires supportent la cle API et certains contextes JWT.

Experience interactive

  • schemas de requete et de reponse reels,
  • exemples generes automatiquement,
  • playground de test depuis la doc,
  • coherence maintenue par la spec Swagger de l API.

Le panneau d autorisation du playground memorise localement la derniere valeur de test. Tu peux donc coller ton JWT ou ta cle technique une seule fois, puis retester les endpoints sans ressaisie a chaque page.

Ordre recommande

  1. Tester POST /partner/contracts/auto/classic.
  2. Suivre la reference avec GET /partner/contracts/requests/{reference}.
  3. Configurer PATCH /partners/me/webhook avant la mise en production.
  4. Valider la Go-live checklist.

Pour une premiere integration, commence par Creer une demande, puis ouvre le flow complet dans Flow assurance-first.

On this page