Aller au contenu principal

Démarrage rapide

Ce guide vous accompagne dans les premières étapes d'une intégration API YAPU — de la compréhension des prérequis au déroulement du processus d'intégration.

Prérequis​

Avant de commencer une intégration API YAPU, assurez-vous que les éléments suivants sont en place :

ExigenceDescription
Contrat signéUne intégration API YAPU nécessite un contrat actif. Le processus de livraison commence après la signature.
Contact YAPU désignéVous travaillerez avec un représentant de l'équipe Customer Success ou Digitalisation de YAPU tout au long du processus.
Équipe technique disponibleVotre organisation doit disposer d'une équipe de développement capable d'implémenter une connexion REST API sur HTTPS.
Capacité JSONToutes les requêtes et réponses des APIs YAPU utilisent JSON. Vos systèmes doivent pouvoir envoyer et analyser du JSON.
Support HTTPSToute communication avec les APIs YAPU doit se faire via HTTPS. HTTP n'est pas pris en charge.
Support IP dynamiqueYAPU fonctionne avec des communications IP dynamiques. Les communications IP statiques ne sont pas prises en charge.

Présentation de l'intégration​

Une intégration API YAPU suit trois phases structurées. Votre contact YAPU vous guide à travers chacune d'elles.

Phase 1 — Spécification (1 à 3 semaines)​

Durant la spécification, YAPU et votre équipe s'alignent sur les exigences d'intégration :

  1. Un appel commun est organisé pour identifier vos besoins en matière d'API REST.
  2. YAPU crée un cas d'usage API et un diagramme de flux de données / utilisateur.
  3. Les deux parties examinent et s'accordent sur le cas d'usage et le flux.
  4. YAPU guide votre équipe dans la spécification des données à transférer.
  5. YAPU crée la documentation technique de l'API.
  6. Les deux parties s'accordent sur la documentation technique finale avant le début du développement.

Phase 2 — Développement (2 à 8 semaines)​

YAPU et votre équipe développent chacun leur côté de l'intégration en parallèle, à partir de la documentation technique convenue. Des appels d'alignement sont organisés si des clarifications sont nécessaires. Le calendrier dépend des priorités logicielles internes de YAPU et de la rapidité avec laquelle votre équipe termine le développement.

Phase 3 — Tests (1 à 2 semaines)​

Les tests se déroulent en deux étapes :

  1. Chaque partie teste sa propre implémentation de manière indépendante.
  2. Des tests d'intégration mutuels sont conduits dans l'environnement de staging.
  3. Les deux parties déploient en production.
  4. Des tests d'intégration mutuels sont conduits dans l'environnement de production.

Une fois les tests de production terminés, le système est prêt à l'utilisation.

À quoi s'attendre​

  • Calendrier : Une intégration typique prend entre 4 et 13 semaines après la signature du contrat, selon la complexité, les priorités et la rapidité de développement du client.
  • Assistance : Votre contact YAPU est disponible tout au long des phases pour répondre aux questions et débloquer les problèmes.
  • Documentation : YAPU fournit la documentation technique de l'API dans le cadre de la phase de spécification. Ce portail sert de référence complémentaire.

Prochaines étapes​

Une fois votre contrat en place et votre contact YAPU désigné, votre première étape est l'appel de spécification. En attendant, explorez les sections suivantes pour préparer votre équipe :

astuce

Utilisez les pages Vue d'ensemble des offres API et Processus d'intégration pour préparer les questions à poser lors de votre appel de spécification avec YAPU.