• Dernière modification le: 09 November 2023

Référence API Open Buy

L'API Open Buy est conçue pour fournir une interface plus rapide, standard et sécurisée pour la recherche et l'achat d'articles en temps réel pour tous les fournisseurs.

Introduction

L'API Open Buy est conçue pour fournir une interface plus rapide, standard et sécurisée pour la recherche et l'achat d'articles en temps réel pour tous les fournisseurs. Il est conçu pour être simple et suit les modèles courants fournis par la plupart des API de commerce électronique.

Les quatre concepts de base de l'API Open Buy comprennent :

Pour plus d'informations sur la façon dont l'API Open Buy affecte les clients et les acheteurs, voir API Open Buy pour les acheteurs.

Téléchargez notre fichier de schéma Open Buy à utiliser dans Postman ou un autre outil compatible OpenAPI 3.0, ou affichez le fichier de schéma directement dans une visionneuse en ligne comme ReDoc.

Méthodes d'authentification

L'API Open Buy peut être authentifiée via :

  • Nom d'utilisateur et mot de passe (similaires à la paire identité/secret cXML)

  • OAuth

Actions

L'API Open Buy vous permet de :

API Verbe Chemin d'accès Action Description
Authentification PUBLIER /authentification/v1.0.0 authentifier Authentification avec le site fournisseur
Rechercher PUBLIER /search/v1.0.0 rechercher Récupérer les données de l'article en fonction d'une requête de recherche
Détails PUBLIER /detail/v1.0.0 détail Récupérer les données d'un article spécifique pour un examen détaillé
Règlement PUBLIER /checkout/v1.0.0 paiement Récupérer les données de l'article pour l'achat

    Authentification

    API Verbe Chemin d'accès Action Description
    Authentification PUBLIER /authentification/v1.0.0 authentifier Authentification avec le site fournisseur

    Exemple de demande d'authentification

    {
    
    	"informations d'identification" : "423j23j2j334l4s04",
    
    	"email" : "email@coupa.com"
    
    }

    Réponses

    Code Description
    200

    Jeton récupéré avec succès

    
    
    {
    
    "token" : "ABC12345"
    
    }

     

    400

    Paramètres de demande non valides ; nous n'avons pas pu tenter de récupérer.

    401

    Non autorisé

    500

    Erreur de service lors de la demande. Veuillez ressayer dans quelques instants

    Rechercher

    API Verbe Chemin d'accès Action Description
    Rechercher PUBLIER /search/v1.0.0 rechercher Récupérer les données de l'article en fonction d'une requête de recherche

    Paramètres

    Élément Description Champ obligatoire ? Unique ? Valeur autorisée Type de données
    requête La requête de recherche oui non any chaîne
    page_number Numéro de page pour les résultats non non tout nombre

    Réponses

    Code Description
    200

    Résultats de la recherche récupérés avec succès

    
    
    {
    
    	"count" : 0,
    
    	"total_count" : 0,
    
    	"résultats" : [
    
    		{
    
    			"source_part_num" : 12345,
    
    			"titre" : "Gants en cuir - XL",
    
    			"url" : "https ://localhost/image",
    
    			"prix" : 100,
    
    			"devise" : "USD",
    
    			"uom" : "EA"
    
    		}
    
    	]
    
    }
    400

    Paramètres de demande non valides ; nous n'avons pas pu tenter de récupérer.

    401

    Non autorisé

    500

    Erreur de service pendant la demande. Veuillez ressayer dans quelques instants

    Détails

    API Verbe Chemin d'accès Action Description
    Détails PUBLIER /detail/v1.0.0 détail Récupérer les données d'un article spécifique pour un examen détaillé

    Paramètres

    Élément Description Champ obligatoire ? Unique ? Valeur autorisée Type de données
    item_id L'identifiant unique de l'article oui non tout chaîne

    Réponses

    Code Description
    200

    Article récupéré avec succès

    
    
    {
    
    	"source_part_num" : 12345,
    
    	"titre" : "Gants en cuir - XL",
    
    	"url" : "https ://localhost/image",
    
    	"prix" : 100,
    
    	"devise" : "USD",
    
    	"uom" : "EA"
    
    }
    400

    Paramètres de demande non valides ; nous n'avons pas pu tenter de récupérer.

    401

    Non autorisé

    500

    Erreur de service lors de la demande. Veuillez ressayer dans quelques instants

    Règlement

    API Verbe Chemin d'accès Action Description
    Règlement PUBLIER /checkout/v1.0.0 paiement Récupérer les données de l'article pour l'achat

    Paramètres

    Élément Description Champ obligatoire ? Unique ? Valeur autorisée Type de données
    item_id L'identifiant unique de l'article oui oui tout chaîne
    quantité Quantité non non tout chaîne

    Réponses

    Code Description
    200

    Article récupéré avec succès

    
    
    {
    
    	"source_part_num" : 12345,
    
    	"titre" : "Gants en cuir - XL",
    
    	"url" : "https ://localhost/image",
    
    	"prix" : 100,
    
    	"devise" : "USD",
    
    	"uom" : "EA"
    
    }
    400

    Paramètres de demande non valides ; nous n'avons pas pu tenter de récupérer.

    401

    Non autorisé

    500

    Erreur de service lors de la demande. Veuillez ressayer dans quelques instants

    Schéma API Open Buy

    Demande d'authentification

    Les informations d'identification et l'e-mail pour récupérer un jeton d'accès.

    Élément Description Champ obligatoire ? Type de données
    identifiants

    Chaîne spécifique au fournisseur pour autoriser la session. Les exemples incluent un jeton d'actualisation, un utilisateur et un mot de passe, ou une clé d'autorisation.

    non chaîne
    e-mail

    Adresse électronique de l'utilisateur

    non chaîne

    Résultat d'authentification

    Le résultat d'une demande d'authentification

    Élément Description Champ obligatoire ? Type de données
    jeton

    Le jeton porteur

    non chaîne

    Détails supplémentaires sur l'article

    Paires de valeurs de nom

    Élément Description Champ obligatoire ? Type de données
    nom Intitulé non chaîne
    valeur Valeur non chaîne

    Résultats de la recherche

    Le résultat d'une demande de recherche

    Élément Description Champ obligatoire ? Type de données
    count

    Décompte de la recherche

    oui nombre entier
    total_count Nombre total approximatif dans le catalogue non nombre entier
    résultats Résultats non Résultat de l'article

    Résultat de l'article

    Le résultat d'une demande de données d'article

    Élément Description Champ obligatoire ? Type de données
    item_id

    Identifiant unique de l'article

    non chaîne
    source_part_num

    Le numéro de pièce du fournisseur

    non chaîne
    titre chaîne

    Le titre de l'article

    non chaîne
    type chaîne

    Type d'article (article, groupe). Le groupe représente un parent d'articles achetables.

    non chaîne
    image

    Une URL vers l'image de l'article

    non chaîne
    vignette

    Miniatures du produit

    non chaîne
    prix

    Prix

    non numéro
    devise

    Devise

    non chaîne
    listPrice

    Liste de prix

    non numéro
    uom

    Prix

    non chaîne
    sommaire

    Description détaillée de l'article

    non chaîne
    manufacturer_name

    Nom du fabricant

    non chaîne
    numéro_de_la_pièce_du_fabricant

    Numéro de pièce du fabricant

    non chaîne
    identifiant_auxiliaire_de_la_pièce_d'origine

    Numéro de la pièce aux du fournisseur

    non chaîne
    unspsc

    UNSPSC

    non chaîne
    délai

    Délai

    non chaîne
    min_order_quantity

    Quantité minimale de commande

    non nombre
    max_order_quantity Quantité maximale de commande non numéro
    order_increment_quantity

    Numéro d'incrément de la

    non numéro
    quantité

    Quantité à payer

    non numéro
    tableDetails Colonnes à afficher si elles sont indiquées dans un tableau non chaîne
    détails Détails non Détails supplémentaires sur l'article
    détaillinks Liens de détail non Détails supplémentaires sur l'article
    detailimages Images détaillées non Détails supplémentaires sur l'article

     

    Une partie ou la totalité de cette page peut avoir été traduite par machine. Toutes nos excuses pour les inexactitudes.