Démarrer

Votre première requête en 4 étapes

Passez de zéro à un appel réel sur la REST API Openprovider.

1

Créez un compte et activez l’accès API

Il vous faut un compte revendeur actif. Connectez-vous au panneau de contrôle, ou créez-en un, pour obtenir votre identifiant et votre mot de passe.

L’accès API est désactivé par défaut et s’active par personne de contact. Dans le panneau de contrôle, allez dans Aperçu du compte → Personnes de contact → puis Ajouter une personne de contact ou sélectionnez-en une existante → onglet API → Activer l’accès API.

Pour les opérations sur les domaines, vous devrez peut-être signer certains contrats de registre avant de commencer. Consultez-les dans Compte → Contrats.

2

Authentifiez-vous pour obtenir un bearer token

Envoyez vos identifiants à l’endpoint /auth/login. La réponse renvoie un jeton qui servira à autoriser toutes les requêtes suivantes.

curl -X POST https://api.openprovider.eu/v1/auth/login \
  -H 'Content-Type: application/json' \
  -d '{
    "username": "you@example.com",
    "password": "your-password",
    "ip": "0.0.0.0"
  }'

Le jeton est renvoyé dans data.token et sa validité est limitée. Mettez-le en cache et réutilisez-le d’une requête à l’autre plutôt que de vous authentifier à chaque appel.

3

Passez votre premier appel autorisé

Transmettez le jeton dans l’en-tête Authorization sous forme de bearer token. Ici, nous vérifions si un domaine est disponible :

curl -X POST https://api.openprovider.eu/v1/domains/check \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "domains": [{ "name": "mybrand", "extension": "com" }]
  }'
4

Explorez la référence complète de l’API

Parcourez chaque endpoint, schéma de requête et exemple de réponse dans la documentation interactive, ou importez la spécification OpenAPI dans Postman.

URL de base et conventions

ÉlémentValeur
URL de basehttps://api.openprovider.eu/v1
ProtocoleHTTPS uniquement
FormatCorps de requête et de réponse en JSON
AuthentificationAuthorization: Bearer <token>
MéthodesGET, POST, PUT, DELETE

Structure de la réponse

Les réponses réussies encapsulent le payload dans une enveloppe prévisible, avec un code numérique (0 indique un succès) et un objet data :

{
  "code": 0,
  "data": { /* result */ },
  "desc": ""
}

Un code différent de zéro signale une erreur. Consultez desc pour le message lisible et gérez proprement les échecs dans votre intégration.