Suite Partenaires

Développez au-dessus de tout

Une API REST avec de la documentation Swagger, des clés limitées par client et une autorisation OAuth 2.1. Récupérez des données, poussez des mises à jour et intégrez Synup dans votre stack existante.

REST · JSON OpenAPI 3.0 OAuth 2.1 + PKCE 9 catégories

Démarrer un essai gratuit Consulter la documentation

Swagger UI disponible sur votre tableau de bord Essai gratuit de 14 jours · Sans carte bancaire

at-risk-clients.js JavaScript

// Clients whose health score dropped below 60
const res = await fetch(
  'https://api.synup.com/v1/clients?health_lt=60&limit=2', {
    headers: {
      'Authorization': 'Bearer sk_live_a1b2c3d4e5f6...',
      'Content-Type': 'application/json'
    }
  }
);

const { data } = await res.json();

200 OK application/json 142 ms

{
  "data": [
    { "id": "cl_8f2ka91", "name": "Harbor Coffee",
      "health": 45, "rating": 3.6, "status": "at_risk" },
    { "id": "cl_3md7x02", "name": "Lakeside Pet Clinic",
      "health": 34, "rating": 3.1, "status": "at_risk" }
  ],
  "has_more": false
}

Les agences développent avec l'API Synup

REST API

Chaque ressource, une seule API uniforme

L'API Synup respecte les conventions REST — des URL orientées ressources, des méthodes HTTP standard et des réponses JSON. L'interface Swagger UI met à votre disposition une documentation interactive permettant de tester directement les requêtes. L'API couvre les fiches locales, les avis, les réseaux sociaux, GBP, les analyses, les campagnes et les opérations de revente.

RESTful, orientée ressources, entrées et sorties en JSON

Swagger UI avec fonction try-it-out pour chaque endpoint

Couverture : fiches locales, avis, réseaux sociaux, GBP, analyses, campagnes, revente

Réponses d'erreur uniformes avec des codes de statut HTTP standard

SRéférence APIv1 Filtrer les endpoints

Méthode	Endpoint	Description
GET	/v1/clients	Lister tous les clients
GET	/v1/clients/:id	Obtenir les détails du client
POST	/v1/clients	Créer un client
GET	/v1/clients/:id/reviews	Lister les avis d'un client
POST	/v1/clients/:id/posts	Créer une publication sur les réseaux sociaux
GET	/v1/clients/:id/listings	Obtenir le statut des fiches locales
GET	/v1/clients/:id/seo/rankings	Obtenir les classements SEO
GET	/v1/clients/:id/aeo/visibility	Obtenir le score de visibilité IA

Voir la référence API complète 8 sur plus de 140 endpoints

api.synup.com/docs

SSynup APIv1.0.4 OAS 3.0

Clients GETPOSTPUTDEL

AvisGETPOST9 ops

Fiches localesGETPUT14 ops

Réseaux sociauxGETPOSTDEL11 ops

Authentification

Clés d'API ou OAuth 2.1 — à vous de choisir

Pour les intégrations simples, générez une clé d'API et transmettez-la sous forme de jeton Bearer. Pour les applications en production, utilisez OAuth 2.1 avec PKCE pour un accès sécurisé et restreint. La fonction Dynamic Client Registration (RFC 7591) permet à votre application de s'enregistrer de manière programmatique.

Authentification par jeton Bearer pour les intégrations rapides

OAuth 2.1 avec PKCE pour les applications en production

Dynamic Client Registration (RFC 7591)

Jetons d'accès de 1 heure, jetons de rafraîchissement de 30 jours

Portées : mcp:read, mcp:write

Jeton BearerLa méthode la plus rapide — un seul en-tête

Authorization: Bearer sk_live_a1b2c3d4e5f6...

PérimètreTous les clients

Format de cléHexadécimal 64 car.

Renouvelez ou révoquez depuis les Paramètres à tout moment

OAuth 2.1 + PKCEPour les applications en production

1S'enregistrerPOST /oauth/mcp/registerclient_id

2AutoriserGET /oauth/mcp/authorizeconsentement

3JetonPOST /oauth/mcp/tokenaccès + rafraîchissement

Scopesmcp:readmcp:write

Jeton d'accès 1 heure · jeton de rafraîchissement 30 jours

Gestion des clés

Clés à portée restreinte par client

Créez des clés API restreintes à aucun, à tous ou à des clients spécifiques. L'agent utilise automatiquement la bonne clé lorsque vous nommez un client dans le chat. Effectuez la rotation des clés sans interruption de service et suivez quelle clé est attribuée à quel client.

Ouvrir Paramètres · Clés API

SClés API3 actives Ajouter une clé API

Clé	Nom	Aperçu	Portée	Créée	Actions
K01	Production — Tous les clientsUtilisé par le conteneur de l'agent	sk_live_a1b2...f6	Tous les clients	2026-03-11	RenouvelerModifierSupprimer
K02	Bella Vista uniquementRestreint à un seul compte client	sk_live_x7y8...z9	1 client	2026-05-02	RenouvelerModifierSupprimer
K03	Staging (non utilisé)Aucun client attribué pour le moment	sk_test_m3n4...p5	Non attribué	2026-06-19	RenouvelerModifierSupprimer

Les modifications de portée prennent effet dès la requête suivante — aucun redéploiement requis

Toutes les clés, identifiants, endpoints et payloads sur cette page sont des exemples illustratifs — remplacez-les par les vôtres avant la publication.

Tout ce dont vous avez besoin pour vous intégrer

Fiches localesRéputationRéseaux sociaux GBPAnalysesCampagnes Localisateur de magasins & PagesGestion des clientsRevendeur

Documentation Swagger UI

Parcourez chaque endpoint, testez des requêtes en direct, consultez les schémas de réponse. Pas besoin de site de documentation séparé.

ClientsGETPOST

AvisGETPUT

Portée des clés par client

Attribuez chaque clé à aucun, à tous ou à des clients spécifiques. L'agent utilise automatiquement la bonne clé.

sk_live_x7y8...z93 clients

OAuth 2.1 + PKCE

Autorisation de niveau production avec enregistrement dynamique des clients et jetons de rafraîchissement.

1POST /oauth/mcp/register

2GET /oauth/mcp/authorize

3POST /oauth/mcp/token → 200

Rotation des clés

Générez une nouvelle clé et remplacez l'ancienne sans interruption de service. Les anciennes clés sont révoquées immédiatement.

sk_live_a1b2...f6Renouveler

Catégories d'API

Endpoints organisés par domaine : Fiches locales, Avis, Réseaux sociaux, GBP, Analyses, Campagnes, Revendeur.

Fiches localesAvisRéseaux sociauxGBPAnalysesCampagnesRevendeur

Synchronisation de clé Anthropic

Collez votre clé API Anthropic une seule fois. Elle se synchronise avec le conteneur de l'agent et se redéploie automatiquement.

sk-ant-...Enregistrer la clé

// Adrian Graphics & Marketing rollout
const results = await synup.get('/v1/campaigns/results');
// nearly every client: increased sales revenue
// many clients: 400%+ within first few months

AG Adrian Graphics & MarketingAgence

Adrian a rapidement déployé Synup auprès de nombreux clients de l'agence — en combinant présence, réputation et campagnes. Les résultats ont été quasi immédiats : presque tous les clients ont vu leur chiffre d'affaires augmenter dès les premiers mois.

Adrian Graphics & MarketingAgence accompagnant Safeway, SportClips et d'autres

Lire l'histoire complète →

FAQ

Ce que demandent les développeurs avant la première requête

Que puis-je faire avec l'API ?

Extraire les données clients (fiches locales, avis, classements, visibilité IA), créer et gérer des publications sur les réseaux sociaux, lancer des analyses, gérer les clients et automatiser les workflows. La couverture s'étend à l'ensemble de l'écosystème de produits Synup.

Comment m'authentifier ?

Pour des intégrations rapides, utilisez un jeton Bearer (clé API). Pour les applications en production, utilisez OAuth 2.1 avec PKCE. Les deux méthodes sont documentées dans Swagger UI.

Puis-je restreindre la portée des clés API à des clients spécifiques ?

Oui. Chaque clé peut être attribuée à aucun client, à tous les clients ou à un sous-ensemble spécifique. L'agent utilise automatiquement la bonne clé en fonction du contexte.

Existe-t-il une limite de débit ?

Oui. Les limites de débit sont documentées par endpoint dans Swagger UI. Les limites standard sont généreuses pour les cas d'usage d'intégration habituels.

Quelle est la différence entre l'API et MCP ?

L'API est de type REST — des endpoints HTTP traditionnels pour récupérer des données et envoyer des mises à jour. MCP est un protocole permettant aux agents IA d'appeler nativement les outils Synup. Utilisez l'API pour vos intégrations personnalisées ; utilisez MCP pour les workflows d'agents IA.

Existe-t-il un SDK ?

L'API utilise les conventions REST standard, tout client HTTP fonctionne donc parfaitement. Nous vous recommandons d'utiliser le client généré par Swagger pour le langage de votre choix.

Commencer à développer

Créez une clé, appelez un endpoint et lisez la réponse. L'interface Swagger UI est accessible sur votre tableau de bord dès le début de votre essai.

curl https://api.synup.com/v1/clients -H "Authorization: Bearer $SYNUP_KEY"

Démarrer un essai gratuit Consulter la documentation

Aucune carte de crédit requise Synchronisation en direct en quelques minutes Annulez à tout moment