# Lister les partenaires

GET /api/partners

  Renvoie une liste des partenaires remplissant les critères donnés en paramètres de requête.

  En-têtes de requête:

    - Authorization – Les identifiants de l’utilisateur

  Paramètres:

    - limit (int) – Le nombre maximum de résultats souhaités (défaut: 20)

    - offset (int) – Le numéro du premier résultat souhaité (défaut: 0)

    - sort (string) – Le paramètre selon lequel les partenaires seront triés Valeurs possibles : `name+`, `name-`, `protocol+`, `protocol-`. (défaut: name+)

    - protocol (string) – Filtre uniquement les partenaires utilisant ce protocole. Peut être renseigné plusieurs fois pour filtrer plusieurs protocoles.

  Status Codes:

    - 200 OK – La liste a été renvoyée avec succès

    - 400 Bad Request – Un ou plusieurs des paramètres de requêtes sont invalides

    - 401 Unauthorized – Authentification d’utilisateur invalide

  Objet JSON de réponse:

    - partners (array) – La liste des partenaires demandés

  Tableau d’objets JSON de réponse:

    - name (string) – Le nom du partenaire

    - protocol (string) – Le protocole utilisé par le partenaire

    - address (string) – L’adresse du partenaire (en format [adresse:port])

    - protoConfig (object) – La configuration du partenaire encodé sous forme d’un objet JSON. Cet objet dépend du protocole.

    - authMethods (array) – La liste des valeurs utilisées par le partenaire pour s’authentifier auprès de Waarp Transfer quand celle-ci s’y connecte.

    - authorizedRules (object) –

      Les règles que le partenaire est autorisé à utiliser pour les transferts.

      - sending (array of string) - Les règles d’envoi.

      - reception (array of string) - Les règles de réception.

  Exemple de requête

      GET https://my_waarp_transfer.net/api/partners?limit=10&sort=name-&protocol=r66 HTTP/1.1
      Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==

  Exemple de réponse

      HTTP/1.1 200 OK
      Content-Type: application/json
      Content-Length: 648

      {
        "partners": [{
          "name": "waarp_r66_2",
          "protocol": "r66",
          "address": "waarp.org:2023",
          "protoConfig": {},
          "authMethods": ["waarp_hostkey_2"],
          "authorizedRules": {
            "sending": ["règle_envoi_1", "règle_envoi_2"],
            "reception": ["règle_récep_1", "règle_récep_2"]
          }
        },{
          "name": "waarp_r66_1",
          "protocol": "r66",
          "address": "waarp.fr:2022",
          "protoConfig": {},
          "authMethods": ["waarp_hostkey_1"],
          "authorizedRules": {
            "sending": ["règle_envoi_1", "règle_envoi_2"],
            "reception": ["règle_récep_1", "règle_récep_2"]
          }
        }]
      }