Recherchez des cartes franchise sur Franchise Direct. Envoyez un mot-clé comme coffee ou food, ou une URL de liste sur franchisedirect.com (recherche, annuaire ou catégorie). La réponse est { results, pagination }.
Chaque carte a minimum_cash_required_display tel qu'imprimé, par exemple $60,000, et minimum_cash_required en dollars entiers, 60000. Passez results[].url à /v2/franchisedirect/franchise.
GET et POST prennent le même query.
GET https://api.piloterr.com/v2/franchisedirect/search?query=coffee
coffee renvoie CoffeeNow sur https://www.franchisedirect.com/coffee-franchises/coffeenow avec $60,000 / 60000. La fiche du même nom renvoie la même paire.
| Paramètre |
Obligatoire |
Exemple |
query |
oui |
coffee |
query est obligatoire. Une URL doit être sur franchisedirect.com. Un chemin de fiche, comme /coffee-franchises/coffeenow, renvoie 400 ici : il appartient à l'endpoint franchise. Une URL de recherche, d'annuaire ou de catégorie est une liste.
Les listes coffee, food et cleaning tiennent sur une page. pagination.page vaut 1. pagination.next vaut null quand le HTML n'a pas de lien Next. total_results et total_pages valent null. per_page est le nombre de cartes.
Le site ignore un page=2 ajouté à la main sur une liste sans pagineur. https://www.franchisedirect.com/search?q=coffee&page=2 renvoie les mêmes six cartes café, page reste 1 et next reste null. Si le HTML contient un lien Next ou Previous, next est cette URL et page est lu dans le paramètre page.
Les URL de cartes sont uniques. minimum_cash_required est le premier nombre de minimum_cash_required_display.
| Champ |
Type |
Sens |
results[].name |
string |
Nom de la franchise |
results[].url |
string |
URL de la fiche |
results[].description |
string ou null |
Résumé de la carte |
results[].category |
string ou null |
Catégorie tirée du chemin, par exemple Coffee Franchises |
results[].minimum_cash_required |
number ou null |
Apport minimum en dollars entiers |
results[].minimum_cash_required_display |
string ou null |
Montant USD imprimé, par exemple $60,000 |
results[].image |
string ou null |
Logo |
pagination.page |
integer |
1 sans pagineur |
pagination.per_page |
integer ou null |
Cartes de la page |
pagination.total_results |
null |
Non affiché |
pagination.total_pages |
null |
Non affiché |
pagination.next |
string ou null |
URL suivante, ou null sans lien Next |
- Comparer l'apport café :
$60,000 pour CoffeeNow et $175,000 pour PJ's Coffee dans la même réponse coffee.
- Parcourir le mot-clé
food, puis garder chaque URL de fiche pour lire le droit d'entrée et l'investissement.
- Vérifier que le montant affiché et le nombre décrivent la même somme avant d'ouvrir la fiche.
| Code |
Sens |
400 |
Requête vide, URL de fiche, ou domaine hors franchisedirect.com |
401 |
Clé API absente |
404 |
La page n'est pas une liste |
500 |
Échec de la récupération |
Franchise Direct Franchise
