Consulter un partenaire

GET /api/partners/(string: partner_name)

Renvoie les informations du partenaire portant le nom partner_name.

En-têtes de requête:

• Authorization – Les identifiants de l’utilisateur

Status Codes:

• 200 OK – Les informations du partenaire ont été renvoyées avec succès

• 401 Unauthorized – Authentification d’utilisateur invalide

• 404 Not Found – Le partenaire demandé n’existe pas

Objet 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 la gateway 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_gateway.net/api/partners/waarp_sftp HTTP/1.1
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==

Exemple de réponse

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

{
  "name": "waarp_sftp",
  "protocol": "sftp",
  "address": "waarp.org:2022",
  "protoConfig": {},
  "authMethods": ["waarp_hostkey"],
  "authorizedRules": {
    "sending": ["règle_envoi_1", "règle_envoi_2"],
    "reception": ["règle_récep_1", "règle_récep_2"]
  }
}