Requêtes et réponses

Notre API serveur d'application - Le Directkit est accessible via Soap WebService (XML) ou JSON-based WebService (JSON). Ce document décrit le format générique des requêtes et des réponses du Directkit :

  • L'encodage des requêtes et réponses est UTF-8
  • Votre choix du l'URL de directkit décide le format des requêtes et réponses (SOAP XML ou JSON):
    • l'URL du Directkit en Soap WebService est https://.../directkitxml/service.asmx
    • l'URL du Directkit en Json WebService est https://.../directkitjson2/service.asmx

N'importe quelle technologie supportant HTTP (PHP, Python, NodeJS, Ruby, Golang ...) peut communiquer avec notre API Direckit.

Le directkitjson2 est souvent plus simple à implémenter et est plus efficace au niveau du réseau. Il est donc plus recommandé que le directkitxml.

Voir aussi : Tutorials

  • Si votre Directkit URL utilisée est https://.../directkit/service.asmx, vous êtes actuellement en train d'utiliser l'instance "legacy" du directkit. Vous devriez migrer vers le directkitxml qui est quasiment identique.
  • Si votre Directkit URL utilisée est https://.../directkitjson/service.asmx, vous êtes actuellement en train d'utiliser l'instance "legacy" du directkit. Vous devriez migrer vers le directkitjson2 qui est quasiment identique.


Requêtes

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
 <soap12:Body>

<MethodName xmlns="Service_mb">

<wlPass>string</wlPass>
<wlLogin>string</wlLogin>
<language> string </language>
<version> string </version>
<walletIp> string </walletIp>
<walletUa>string </walletUa>
... 

</MethodName>

</soap12:Body>
</soap12:Envelope>

{

    "p":{   
        "wlPass":"string",
        "wlLogin":"string",
        "language":" string ",
        "version":" string ",
        "walletIp":" string ",
        "walletUa":"string"
        ...

    }

}

MethodName : nom de la methode, par exemple "RegisterWallet"

Toutes les requêtes devront contenir les informations suivantes :

Element

Description

Requis

Format

Exemple

wlLogin

Identifiant de connexion de la marque blanche

Oui

[1 : 50] car

Pizza87

wlPass

Clé fournie lors de la création de la marque blanche, vous pouvez la modifier en vous connectant au backoffice.

Oui

[1 : 50] car

aizohdeh78

language

Langue dans laquelle doit être retournée la réponse

Oui

[2 : 3] car

fr : Français (par défaut)

version

Version de la méthode. La requête et la réponse peuvent être différents pour une même méthode, selon la version renseignée.

Oui

[4] car

1.0 (par défaut)

walletIp

Adresse IP de l'utilisateur final

Oui

car

91.222.226.32

walletUa

User-agent de l'utilisateur final

Non

car

Mozilla/5.0 (Windows NT 6.1; WOW64) 

Veuillez nous envoyer l'IP et le user-agent de votre client, pas de votre serveur. Ces données nous aident dans la lutte contre la fraude et le service client.

Réponses

Chaque réponse est retournée sous forme de chaîne de caractères:

<?xml version="1.0" encoding="utf-8"?>
<SomeResult xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="Service_mb_xml">
    <E>...</E> <!-- disponible seulement au case d'erreur -->
    <Key>{Value}</Key>
</SomeResult>

{
    "d": {
        "__type": "WonderLib.SomeResult"

        "E": {..} /* disponible seulement en cas d'erreur */

        "Key": {value} /* résultat de la requête */
    } 

}

JSON2 : Exemple de Requête-Réponse

Vous pouvez appeler DirectkitJson avec PostMan sur une machine dont l'IP est autorisée.

Astuce pour utilisateurs JSON

  • Dans le HEADER de votre requête, vous devez spécifier le content-type : "Content-type: application/json; charset=utf-8"
  • Ajoutez le nom de la méthode appelée à la fin de l'URL du DIRECTKIT, c'est là que vous devrez POST vos données. Exemple pour appeler RegisterWallet: https://.../directkitjson2/service.asmx/RegisterWallet

Astuce pour utilisateurs du SOAP XML

Une description du WebService (WSDL) est toujours disponible. Si vous souhaitez l'utiliser, ajoutez simplement ?wsdl à l'URL du DIRECTKIT.

  • La plupart des technologies orienté-objet (C#, Java..) supporte la génération de l'ensemble des structures des requêtes / réponses en se basant sur ce WSDL. La génération de ces "artifacts" (ou "stubs") facilite votre dévelopement mais est complètement optionelle. N'importe quelle technologie qui supporte le protocole HTTP (PHP, Python, NodeJs, Ruby...) peut communiquer avec notre Directkit API.
  • Vous pourriez lire directement le WSDL pour connaître la structure d'entrée / sortie exacte d'un service (Web Method) sans passer à la documentation.