E-commerce
Melhor Envio dans votre produit et vos agents IA, via une API
Le toolkit Melhor Envio couvre les devis d'expédition entre CEP, le panier d'étiquettes, le paiement et la génération d'étiquettes, l'impression, la recherche et l'annulation d'étiquettes, et le solde du portefeuille. Votre client connecte Melhor Envio une fois via OAuth, et votre boutique, outil de marketplace ou agent IA exécute chaque opération via Connect, qui stocke et renouvelle les identifiants et journalise chaque exécution.
15 jours d'essai. Sans carte bancaire.
POST https://connect.reportei.com/api/tools/melhor_envio_calculate_shipping/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"from": {},
"to": {},
"products": []
}
}Fonctionnement
Du client connecté au premier appel à Melhor Envio.
- 1
Votre client connecte son compte
Votre système ouvre une session Connect pour le toolkit et votre client connecte son compte Melhor Envio. Vous recevez l'id de la connexion.
- 2
Votre produit appelle la tool
Un POST sur /api/tools/{tool}/execute avec l'id de la connexion et les arguments. En cas de succès, Connect conserve le statut et le corps de la réponse de l'app.
- 3
Connect s'occupe du reste
Il stocke l'identifiant chiffré, renouvelle les tokens des connexions OAuth qui le permettent et enregistre les exécutions dans un journal d'audit consultable via l'API.
Cas d'usage
Ce que votre produit fait avec Melhor Envio.
Devis d'expédition au paiement
Appelez Calculer l'expédition avec les produits et les deux CEP pour afficher le prix et le délai de chaque transporteur avant que l'acheteur paie.
Expédier une commande de bout en bout
Créez un article du panier, achetez-le avec le portefeuille, générez l'étiquette et imprimez-la, depuis votre propre écran de commandes.
Un agent répond où est ma commande
Un agent IA retrouve une étiquette par code de suivi ou CPF et lit son statut ainsi que les dates de dépôt et de livraison.
Tools
12 tools Melhor Envio
- Calculer l'expéditionPOSTÉtablit un devis d'expédition de produits entre deux CEP et renvoie une entrée par service, avec id, transporteur, prix, délai de livraison, les colis et un error quand le service ne dessert pas le trajet. custom_price et custom_delivery_time incluent les frais et remises du compte. Seuls les services activés pour l'intégration dans le panneau Melhor Envio sont cotés.
- Créer un article du panierPOSTAjoute une étiquette au panier du compte et la renvoie. Son id est l'id de l'étiquette dans les autres outils. Rien n'est payé avant Acheter des étiquettes. Correios, J&T et Loggi acceptent un colis par appel : pour plusieurs colis, ajoutez un article par colis.
- Lister les articles du panierGETListe les étiquettes du panier qui n'ont pas encore été payées, avec id, service, prix, expéditeur, destinataire et colis. Les étiquettes restent 20 jours dans le panier. 10 par page : passez page pour les suivantes, jusqu'à last_page.
- Supprimer un article du panierDELETERetire du panier une étiquette qui n'a pas encore été payée.
- Acheter des étiquettesPOSTPaie des étiquettes du panier avec le solde du portefeuille Melhor Envio et renvoie l'achat, avec le total et les étiquettes, désormais débloquées. Le portefeuille doit avoir un solde suffisant : vérifiez avec Obtenir le solde. Les étiquettes payées doivent encore passer par Générer des étiquettes.
- Générer des étiquettesPOSTGénère des étiquettes payées, ce qui est requis avant Imprimer des étiquettes, et renvoie le résultat pour chaque id. Une étiquette générée doit être déposée sous 20 jours, ou 7 jours avec Correios.
- Imprimer des étiquettesPOSTRenvoie un lien pour imprimer des étiquettes générées. Un lien privé ne s'ouvre que pour quelqu'un connecté au compte Melhor Envio ; un lien public s'ouvre pour toute personne qui l'a.
- Lister les étiquettesGETListe les étiquettes du compte avec id, protocole, statut, service, prix, code de suivi et les dates de paiement, de génération, de dépôt et de livraison. 10 par page : passez page pour les suivantes, jusqu'à last_page.
- Obtenir une étiquetteGETRenvoie une étiquette avec statut, service, prix, expéditeur, destinataire, colis, code de suivi et les dates de paiement, de génération, de dépôt et de livraison.
- Rechercher des étiquettesGETTrouve des étiquettes par une valeur exacte : l'id, le protocole, le code de suivi, le code d'autorisation, ou le CPF ou CNPJ de l'expéditeur ou du destinataire.
OAuth avec l'app de votre produit
Vous enregistrez une fois l'app OAuth de votre produit, avec POST /api/merchants/credentials/melhor_envio, et votre client autorise le compte sur un écran de consentement. Connect renouvelle le token avant son expiration.
Questions sur le toolkit Melhor Envio
Dois-je intégrer l'API Melhor Envio moi-même ?
Non. Connect fournit 12 tools Melhor Envio décrites et prêtes. Votre client connecte son compte et votre système appelle chaque tool par le même endpoint, avec le même format de requête.
Comment mon client connecte-t-il son compte Melhor Envio ?
Avec le mode accepté par le toolkit : OAuth avec l'app de votre produit. Connect stocke l'identifiant chiffré et ne le renvoie jamais à votre système.
Est-ce compatible avec les agents IA ?
Oui. L'input de chaque tool est décrit en JSON Schema, que votre agent utilise directement comme définition de tool. L'agent choisit la tool et les arguments, et votre système fait l'appel à Connect.
Mon client doit-il avoir un compte Reportei ?
Non. Votre client connecte son compte sur un écran de Connect, ou votre système envoie l'identifiant via l'API, et il continue d'utiliser uniquement votre produit.
Voyez Connect appliqué à votre produit.
Essayez-le pendant 15 jours sans carte, ou présentez votre cas à notre équipe.
