• Last edited on: 18 December 2021

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 schémas communs que la plupart des API de commerce électronique fournissent.

Les quatre concepts fondamentaux de l'API Open Buy sont les suivants :

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

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)

  • Authentifier

Actions

L'API Open Buy vous permet de :

API Verbe Chemin d'accès Action Description
Authentification POSTE /authentication/v1.0.0 authentifier Authentification avec le site fournisseur
Recherche POSTE /search/v1.0.0 rechercher Récupérer des données d'article basées sur une requête de recherche
Détail POSTE /detail/v1.0.0 détail Récupérer les données d'un article spécifique pour un examen détaillé
Règlement POSTE /checkout/v1.0.0 caisse Récupérer les données des articles pour achat

Authentification

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

Exemple de demande d’authentification

{
	"credentials": "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 ; impossible de tenter la récupération.

401

Non Autorisé

500

Erreur de service pendant la demande. Veuillez réessayer ultérieurement

Recherche

API Verbe Chemin d'accès Action Description
Recherche POSTE /search/v1.0.0 rechercher Récupérer des données d'article basées sur une requête de recherche

Paramètres

Élément Description Champ obligatoire ? Unique ? Valeur autorisée Type de données
question La requête de recherche oui no tout chaîne
numéro_de_page Numéro de page des résultats no no tout numéro

Réponses

Code Description
200

Résultats de la recherche récupérés


{
	"count": 0,
	"total_count": 0,
	"results": [
		{
			"source_part_num": 12345,
			"title": "Leather Gloves - XL",
			"url": "https://localhost/image",
			"price": 100,
			"currency": "USD",
			"uom": "EA"
		}
	]
}
400

Paramètres de demande non valides ; impossible de tenter la récupération.

401

Non Autorisé

500

Erreur de service pendant la demande. Veuillez réessayer ultérieurement

Détail

API Verbe Chemin d'accès Action Description
Détail POSTE /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
id_article ID d'article unique oui no tout chaîne

Réponses

Code Description
200

Article récupéré avec succès


{
	"source_part_num": 12345,
	"title": "Leather Gloves - XL",
	"url": "https://localhost/image",
	"price": 100,
	"currency": "USD",
	"uom": "EA"
}
400

Paramètres de demande non valides ; impossible de tenter la récupération.

401

Non Autorisé

500

Erreur de service pendant la demande. Veuillez réessayer ultérieurement

Règlement

API Verbe Chemin d'accès Action Description
Règlement POSTE /checkout/v1.0.0 caisse Récupérer les données des articles pour achat

Paramètres

Élément Description Champ obligatoire ? Unique ? Valeur autorisée Type de données
id_article ID d'article unique oui oui tout chaîne
quantité Quantité no no tout chaîne

Réponses

Code Description
200

Article récupéré avec succès


{
	"source_part_num": 12345,
	"title": "Leather Gloves - XL",
	"url": "https://localhost/image",
	"price": 100,
	"currency": "USD",
	"uom": "EA"
}
400

Paramètres de demande non valides ; impossible de tenter la récupération.

401

Non Autorisé

500

Erreur de service pendant la demande. Veuillez réessayer ultérieurement

Schémas API Open Buy

Demande d'authentification

Identifiants et adresse e-mail pour récupérer un jeton d'accès.

Élément Description Champ obligatoire ? Type de données
lettres de créance

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

no chaîne
courrier électronique

Adresse électronique de l'utilisateur

no chaîne

Résultat d'authentification

Résultat d'une demande d'authentification

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

Le jeton porteur

no chaîne

Détails des articles supplémentaires

Paires de valeurs de nom

Élément Description Champ obligatoire ? Type de données
Nom Nom no chaîne
valeur Valeur no chaîne

Résultats de la recherche

Résultat d'une demande de recherche

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

Nombre de recherches

oui entier
total_count Nombre total approximatif dans le catalogue no entier
résultats Résultats no Résultat des articles

Résultat des articles

Résultat d'une demande de données d'article

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

ID d'article unique

no chaîne
source_part_num

Numéro de pièce du fournisseur

no chaîne
titre chaîne

Titre de l'article

no chaîne
type chaîne

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

no chaîne
image

URL vers l'image de l'article

no chaîne
miniature

Miniature du produit

no chaîne
prix

Prix

no numéro
devise

Devise

no chaîne
PrixListe

Prix catalogue

no numéro
udm

Prix

no chaîne
résumé

Description détaillée de l'article

no chaîne
nom_fabricant

Nom du fabricant

no chaîne
numéro_pièce_fabricant

Numéro de pièce du fabricant

no chaîne
partie_source_id_auxiliaire

Numéro de pièce auxiliaire du fournisseur

no chaîne
unspsc

UNSPSC

no chaîne
délai

Délai

no chaîne
quantité_commande_min

Quantité de commande minimale

no numéro
quantité_commande_max Quantité de commande maximale no numéro
quantité_incrément_commande

Numéro d'incrément de commande

no numéro
quantité

Quantité pour le paiement

no numéro
détailsTable Colonnes à afficher si elles sont affichées dans un tableau no chaîne
détails Détails no Détails des articles supplémentaires
liens de détail Liens de détail no Détails des articles supplémentaires
détails Images détaillées no Détails des articles supplémentaires

 

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