# Programmer un transfert

POST /api/transfers

  Obsolète depuis la version 0.1.0: Les propriétés `sourcePath` et `destPath` de la requête ont été remplacées par les propriétés `localFilepath` et `remoteFilepath`.

  Obsolète depuis la version 0.1.0: La propriété `startDate` de la requête a été remplacée par la propriété `start`.

  Supprimé dans la version 0.5.0: Les propriétés `blockSize`, `blockCheck` et `hashAlgo` ont été supprimées afin de simplifier le code. Ces propriétés n’étaient que très peu utilisées.

  Programme un nouveau transfert avec les informations renseignées en format JSON dans le corps de la requête.

  En-têtes de requête:

    - Authorization – Les identifiants de l’utilisateur

  Objet JSON de requête:

    - isServer (bool) – Précise si Waarp Transfer était à l’origine du transfert

    - rule (string) – L’identifiant de la règle utilisée

    - isSend (bool) – Indique le transfert est un envoi (`true`) ou une réception (`false`).

    - client (string) – Le nom du client avec lequel effectuer le transfert. Peut être omit si Waarp Transfer ne possède qu’un seul client du protocole concerné, auquel cas, le client en question sera sélectionné automatiquement.

    - account (string) – Le nom du compte ayant demandé le transfert

    - partner (string) – Le nom du serveur/partenaire auquel le transfert a été demandé

    - partner – Le nom du serveur/partenaire auquel le transfert a été demandé

    - sourcePath (string) – Déprécié. Le chemin du fichier source

    - destPath (string) – Déprécié. Le chemin de destination du fichier

    - file (string) – Le chemin du fichier à transférer

    - output (string) – Le chemin de destination du fichier

    - start (date) – La date de début du transfert (en format ISO 8601)

    - transferInfo (object) – Des informations de transfert personnalisées sous la forme d’une liste de pairs clé:valeur, c’est-à-dire sous forme d’un objet JSON.

  Status Codes:

    - 202 Accepted – Le transfert a été lancé avec succès

    - 400 Bad Request – Un ou plusieurs des paramètres du transfert sont invalides

    - 401 Unauthorized – Authentification d’utilisateur invalide

  En-têtes de réponse:

    - Location – Le chemin d’accès au nouveau transfert créé

  Exemple de requête

      POST https://my_waarp_transfer.net/api/transfers HTTP/1.1
      Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
      Content-Type: application/json
      Content-Length: 212

      {
        "isServer": false,
        "rule": "règle_1",
        "account": "toto",
        "partner": "waarp_r66",
        "file": "chemin/du/fichier",
        "output": "destination/du/fichier",
        "start": "2019-01-01T02:00:00+02:00",
        "transferInfo": { "key1": "val1", "key2": 2, "key3": true }
      }

  Exemple de réponse

      HTTP/1.1 202 ACCEPTED
      Location: https://my_waarp_transfer.net/api/transfers/123