Référence API

Accédez aux fonctions de gestion de vos ressources Edgegap en utilisant des requêtes HTTP.

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

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 en tant qu'en-tête HTTP (incluez le mot jeton):

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 offre un accès illimité à votre compte. Voir pour des points de terminaison et des fonctions API sécurisés côté 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 :

{
  "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 les réponses paginées, 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 assurer la stabilité de la plateforme et éviter les factures surprises, nous limitons le nombre de requêtes API de votre organisation :

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

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

Contactez-nous vers préparez les sorties de plan, effectuez des tests de charge, estimez le trafic de lancement et préparez le succès.