Créer un partenaire¶
-
POST
/api/partners
¶ Ajoute un nouveau partenaire avec les informations renseignées en JSON.
Request Headers: - Authorization – Les identifiants de l’utilisateur
Request JSON Object: - 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.
Status Codes: - 201 Created – Le partenaire a été créé avec succès
- 400 Bad Request – Un ou plusieurs des paramètres du partenaire sont invalides
- 401 Unauthorized – Authentification d’utilisateur invalide
Response Headers: - Location – Le chemin d’accès au nouveau partenaire créé
Exemple de requête
POST https://my_waarp_gateway.net/api/partners HTTP/1.1 Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ== Content-Type: application/json Content-Length: 140 { "name": "waarp_sftp", "protocol": "sftp", "address": "localhost:2022", "protoConfig": {} }
Exemple de réponse
HTTP/1.1 201 CREATED Location: https://my_waarp_gateway.net/api/partners/waarp_sftp