English 中文TürkçeРусскийFrançaisTiếng ViệtEspañol日本語

Autorisation de l'API serveur et format des requêtes

Autorisation

Les requêtes API doivent être authentifiées avec votre clé API secrète ou publique, passée en en-tête Authorization. Vous pouvez les trouver dans les App Settings. Le format de la valeur est Api-Key {your-secret-api-key}, par exemple Api-Key secret_live_....

Important

Les clés API sont spécifiques à chaque application. Si vous avez plusieurs applications, veillez à utiliser des clés différentes pour chacune d’elles.

Format de requête

En-têtes

Les requêtes de l’API côté serveur nécessitent des en-têtes spécifiques et un corps JSON. Utilisez les informations ci-dessous pour structurer vos requêtes.

En-têteDescription
adapty-profile-id

L’identifiant du profil Adapty de l’utilisateur. Visible dans le champ Adapty ID sur la page Adapty Dashboard -> Profiles -> profil spécifique.

Interchangeable avec adapty-customer-user-id, utilisez l’un ou l’autre.

adapty-customer-user-id

L’identifiant de l’utilisateur dans votre système. Visible dans le champ Customer user ID sur la page Adapty Dashboard -> Profiles -> profil spécifique.

Interchangeable avec adapty-profile-id, utilisez l’un ou l’autre.

⚠️ Fonctionne uniquement si vous identifiez les utilisateurs dans votre application dans le code de votre application à l’aide du SDK Adapty.

adapty-platform(optionnel) Précisez la plateforme de l’appareil sur lequel l’application est installée. Nous recommandons de définir ce paramètre dans les requêtes Create profile et Update profile lors de la modification de l’objet Installation Meta, car il dépend de l’appareil utilisé par l’utilisateur, et un même utilisateur peut avoir plusieurs appareils. Valeurs possibles : iOS, macOS, iPadOS, visionOS, Android ou web.
Content-TypeDéfinissez la valeur application/json pour que l’API traite la requête.

Corps

L’API attend un corps au format JSON contenant les données nécessaires à la requête.

Limites de débit

Les limites de débit sont appliquées par clé API, et la limite qui s’applique à votre application est assignée à votre clé — il n’existe pas de chiffre unique valable pour toutes les applications. Si vous dimensionnez une intégration à fort volume, ou si vous commencez à recevoir des réponses 429, contactez le support pour savoir quelle limite s’applique à votre application.

Deux points à prendre en compte dans votre conception :

  • La limite est un débit soutenu, non un budget à la minute. Les requêtes sont lissées sur la fenêtre temporelle et seules de courtes rafales au-delà du débit sont absorbées ; un rythme de requêtes régulier porte donc bien plus loin qu’envoyer en une seule fois le volume d’une minute.
  • Certains endpoints ont leur propre limite, plus basse. Créer une transaction en monnaie virtuelle autorise par défaut 600 requêtes par minute et par application, indépendamment de la limite globale de votre application.

Les requêtes dépassant la limite échouent avec 429 Too Many Requests. Réessayez avec un backoff, et respectez l’en-tête Retry-After lorsque la réponse en contient un.

Faire tourner les clés API

Si vous avez besoin de faire tourner vos clés API secrètes :

  1. Dans Settings → General, cliquez sur Generate new key, puis cliquez sur l’icône de corbeille à côté de l’ancienne clé.
  2. Mettez à jour la clé utilisée dans votre application.

Prochaine étape — les requêtes :