# Référence de l’API

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

<a href="https://raw.githubusercontent.com/edgegap/openapi-specification/refs/heads/main/edgegap-v2-openapi.yaml" class="button primary" data-icon="square-down">Télécharger openapi \[v2]</a> <a href="https://api.edgegap.com/swagger.json" class="button secondary" data-icon="square-down">Télécharger openapi \[v1]</a>&#x20;

### Jeton d'authentification

Générez (et consultez) vos jetons secrets pour l'API Edgegap dans [Tableau de bord - Paramètres utilisateur / Jetons](https://app.edgegap.com/user-settings?tab=tokens).

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`

{% hint style="danger" %}
**N'intégrez pas les endpoints de l'API Edgegap dans le client du jeu, car votre jeton API offre un accès illimité à votre compte. Voir** [Broken link](https://docs.edgegap.com/docs.edgegap.com-fr/docs/broken-reference "mention") **pour des endpoints et des fonctions sécurisés destinés au client.**
{% endhint %}

{% hint style="success" %}
Si vos jetons secrets sont compromis, supprimez-les et mettez à jour les mots de passe des membres de l'organisation.
{% endhint %}

### 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 :

<pre class="language-json"><code class="lang-json">{
  "count": 100,
  "data": ["foo-0", "[...]", "bar-9"],
  "<a data-footnote-ref href="#user-content-fn-1">pagination</a>": {
    "number": 1,
    "next_page_number": 2,
    "previous_page_number": null
    "paginator": {
      "num_pages": 10
    },
    "has_next": true,
    "has_previous": false
  }
}
</code></pre>

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 inattendues, nous limitons le taux d'utilisation de l'API de votre organisation :

* [deployments](https://docs.edgegap.com/docs.edgegap.com-fr/learn/orchestration/deployments "mention") à 40 requêtes par seconde,
* [#context-and-status](https://docs.edgegap.com/docs.edgegap.com-fr/learn/orchestration/deployments#context-and-status "mention") à 20 requêtes par seconde.

{% hint style="info" %}
[Contactez-nous](mailto:info@edgegap.com) pour **planifier des sorties, effectuer des tests de charge, estimer le trafic de lancement et vous préparer au succès.**
{% endhint %}

[^1]: contient des informations de pagination
