Pass-Maege API

API RESTful

Documentation

Guide d'Utilisation API Provider

Guide étape par étape pour intégrer l'API Provider

1

Authentification

Connectez-vous avec vos identifiants provider

Endpoint de connexion

POST /api/v1/provider/login
Payload requis :
{
  "provider_key": "votre_cle_provider",
  "pass_key": "votre_cle_secrete"
}

Réponse attendue

{
  "success": true,
  "message": "Connexion réussie",
  "data": {
    "user": {...},
    "token": "votre_token_bearer",
    "token_type": "Bearer"
  }
}

Conservez le token pour les prochaines requêtes

2

Récupérer les Ressources

Obtenez les listes d'ambassades et de validités

Liste des Ambassades

GET /api/v1/provider/embassies

Headers requis :

Authorization: Bearer {votre_token}

Liste des Validités

GET /api/v1/provider/validities

Headers requis :

Authorization: Bearer {votre_token}
3

Gestion des Demandes

Créez, consultez et gérez les demandes de passeport

Créer une demande

POST /api/v1/provider/applications
Voir le payload requis 
{
  "givenName": "John",
  "familyName": "Doe",
  "email": "john.doe@example.com",
  "phone": "+1234567890",
  "birthDate": "1990-01-01",
  "genre": "male",
  "embassyId": "uuid-ambassade",
  "notes": "Notes optionnelles"
}

Lister vos demandes

GET /api/v1/provider/applications
4

Documentation Complète

Accédez à la documentation interactive Swagger

Pour une documentation complète avec exemples interactifs :

Ouvrir la Documentation Swagger

Exemples de Code

Tests Interactifs

Schémas Détaillés

Conseils Pratiques

Conservez votre token Bearer pour toutes les requêtes authentifiées

Utilisez la documentation Swagger pour tester vos intégrations

Vérifiez les codes de statut HTTP pour gérer les erreurs

Les demandes sont automatiquement liées à votre provider_key