Référence de l'API

Accédez aux fonctions de gestion de vos ressources Edgegap à l’aide de requêtes HTTP.

Télécharger OpenAPI [v2] Télécharger OpenAPI [v1]

Si vous avez besoin d’aide, veuillez nous contacter sur Discord. Pour l’assistance aux jeux en direct, consultez notre système de tickets.

Jeton d’authentification

Générez (et consultez) vos jetons secrets pour l’API Edgegap dans Tableau de bord - Paramètres utilisateur / Jetons.

Ajoutez votre jeton secret à chaque requête API sous forme d’en-tête HTTP (incluez le mot token):

Authorization: token xxxxxxxx-e458-4592-b607-c2c28afd8b62

N’intégrez pas les points de terminaison de l’API Edgegap dans le client du jeu, car votre jeton API donne un accès illimité à votre compte. Consultez Intégration pour les points de terminaison et fonctions API sécurisés destinés au client.

Si vos jetons secrets sont compromis, supprimez-les et mettez à jour les mots de passe des membres de l’organisation.

Pagination des réponses

Si une réponse contient trop d’éléments, nous renvoyons un sous-ensemble de données avec des informations de pagination :

{
  "total_count": 100,
  "data": ["foo-0", "[...]", "bar-9"],
  "pagination": {
    "number": 1,
    "next_page_number": 2,
    "previous_page_number": null
    "paginator": {
      "num_pages": 10
    },
    "has_next": true,
    "has_previous": false
  }
}

Pour une réponse paginée, utilisez les paramètres page et limit pour récupérer plus de résultats :

• deuxième page : https://api.edgegap.com/v1/apps?page=2

• plus de résultats : https://api.edgegap.com/v1/apps?limit=20

• combiné : https://api.edgegap.com/v1/apps?page=2&limit=20

Limitation du débit

Pour garantir la stabilité de la plateforme et éviter des factures surprises, nous limitons le débit d’utilisation de l’API de votre organisation :

• Déploiements à 40 requêtes par seconde,

• Déploiements à 20 requêtes par seconde.

Contactez-nous sur planifiez les sorties, effectuez des tests de charge, estimez le trafic de lancement et préparez-vous au succès.