Service d'authentification
Contrat WSDLhttp://api.dolist.net/v2/AuthenticationService.svc?wsdl
Exemple disponible
  • Implémentation en PHP
  • Implémentation en .NET C# 3.5
  • Requête SOAP

  • Définition

    Le service d'authentification vous permet d'accéder à l'ensemble des Web Services Dolist. Ce système repose sur l'attribution de jetons d'authentification (Token) via une clé d'authentification. Ces jetons, associés à l'identifiant de votre compte (fournis par Dolist lors de la création de cet dernier), permettront alors de se connecter aux Web Services Dolist.

    Votre AccountId

    L'AccountId est l'identifiant de votre compte client Dolist. Il est généré dès la création de votre compte.
    Il est également disponible sur l'extranet Dolist. Rendez-vous dans l'onglet Administration, puis en "G.2 - Les Webservices".

    Votre Clé API

    La clé API est une clé de déclaration auprès des services Dolist.
    Chaque clé est unique et propre à un compte client. Sans cette clé, vous ne pourrez pas vous connecter à nos différentes API.
    Pour la récupérer, vous devez vous connecter sur la plateforme Dolist et aller sur l'onglet Administration, puis en "G.2 - Les Webservices".

    Service d'authentification

    Le Web Service d'authentification vous permet de demander un jeton d'authentification pour vous connecter ensuite à un web service.
    Le jeton renvoyé est disponible pour un nombre illimité d'appels pendant 1 heure.
    Une fois l’heure écoulée, il faudra effectuer une nouvelle demande de jeton pour pouvoir accéder aux Web Services.

    Nom de la méthode : GetAuthenticationToken

    Cette méthode vous permet de récupérer un jeton (Token) pour un nombre illimité d'appels à nos Web Services.
    Les paramètres attendus en entrée
    ChampTypeDescription
    authenticationRequestAuthenticationRequestDemande d'authentification
    Les valeurs renvoyées
    TypeDescription
    AuthenticationTokenResponseRenvoie le jeton d'authentification

    Les objets du service d'authentification

    AuthenticationRequest

    Cet objet contient la clé d'authentification et l'identifiant de votre compte.
    ChampTypeDescription
    AccountIDintIdentifiant du client
    AuthenticationKeystringClé d'authentification
    ListIDintIdentifiant du client: obsolète. Utilisez AccountID à la place

      AuthenticationTokenResponse

      Cet objet contient le jeton d'authentification et sa date de fin de validité.
      ChampTypeDescription
      DeprecatedDatedateTimeDate de fin de validité du jeton d'authentification
      KeystringClé du jeton d'authentification

        Liste des erreurs communes

        CodeNomDescription
        0UnexpectedExceptionErreur inattendue
        1AuthenticationExceptionErreur d'authentification
        2NullTokenExceptionLe token est null, vérifiez que l'objet est correctement passé à la méthode et que les propriétés sont renseignées
        3NullRequestExceptionL'objet 'request' est null, vérifiez que l'objet est correctement passé à la méthode et que les propriétés sont renseignées
        4ForbiddenActionExceptionL'action demandée n'est pas autorisée
        5InvalidArgumentExceptionLes arguments passés à la méthode ne sont pas valides, vérifiez les types des propriétés, leurs noms et leur nullité
        6BadRequestExceptionLa requête n'est pas correcte
        7NothingToDoExceptionLa requête demandée n'effectue aucun traitement, car les données soient déjà à jour, il est possible que la requête ai été exécuté plusieurs fois
        8InvalidDataTypeExceptionLe type de donnée n'est pas valide
        9UnknownTicketExceptionLe ticket n'est pas connu, vérifiez la valeur de celui-ci
        10UnavailableTicketResultExceptionLe résultat associé n'est pas disponible, le traitement de la demande n'est pas terminé, veuillez réessayer plus tard.
        11InvalidDatePeriodExceptionL'intervalle de temps n'est pas valide, vérifiez les dates passées à la requête
        999998TokenNullLe token est null, vérifiez que l'objet est correctement passé à la méthode et que les propriétés sont renseignées
        999999TokenNotAuthorizedL'objet 'token' n'est pas autorisé, vérifiez les propriétés