Si vous êtes client chez nous et souhaitez en faire plus, pour interfacer votre caisse avec un outil externe par exemple, vous aurez besoin de passer par notre API.
Pour bien l'utiliser, 2 conditions :
avoir un minimum de connaissances en programmation, et connaitre les bases du HTML
parcourir la documentation disponible ici : http://documentation.tactill.com
Identification :
Pour communiquer avec l'API vous aurez besoin de passer votre abonnement sur la formule Entreprise.
Pour connaitre votre API_Key, propre à chaque compte, laissez-nous un petit mot sur le chat en bas à droite de l'écran ;)
Vous aurez ensuite deux possibilités :
1- transmettre votre API_Key dans un header sous le nom "x-api-key" exemple
curl --request GET \
--url 'https://api4.tactill.com/v1/catalog/articles?node_id=yyyyyyyy' \
--header 'x-api-key: xxxxxxxx' \a
2- transmettre votre API_Key via l'URL de vos requêtes
Exemple :
Maintenant prenons un exemple de bout en bout, vous voulez récupérer les infos de tous les articles de votre compte :
L'affichage des articles est une fonction de l'API "catalog", il s'agit d'une requête GET dont voici l'URL https://api4.tactill.com/v1/catalog/articles
Le champ requis, dans ce cas, est "node_id"
Pour trouver votre "node_id", nous aurons besoin de l'API "account", c'est une requête GET à l'URL https://api4.tactill.com/v1/account/account
Renseignez votre API_Key : https://api4.tactill.com/v1/account/account?api_key=abc
Vous recevrez une réponse 200 en cas de succès (404 ou 403 en cas d'erreur). Voici le modèle d'une réponse success :
{"_id": "aaa",
"account_id": "bbb",
"role": "ccc",
"fastpass": "9310",
"api_key": "ddd",
"__v": 3,
"profile_id": "eee",
"permissions": [],
"nodes": ["xxx"],
"shops": ["yyy"],
"companies": ["zzz"],
"last_connected": "2018-03-30T10:36:22.042Z",
"deprecated": false,
"updated_at": "2018-03-30T10:36:22.042Z", "created_at": "2018-03-16T15:08:38.594Z", "email": "mon@email.com",
"first_name": "Martin",
"last_name": "Dupont"}
Vous voyez que vous n'avez qu'une node, c'est "xxx" vous pouvez maintenant faire une requête GET sur catalog/articles comme suit https://api4.tactill.com/v1/catalog/articles?api_key=abc@node=xxx
Vous recevrez à cette étape une réponde 200 en cas de success, un tableau d'objets de la forme suivante :
{"_id": "aaa",
"node_id": "xxx",
"category_id": "bbb",
"ignore_stock": true,
"icon_text": "defa",
"in_stock": false,
"color": "#57DB47",
"name": "default",
"full_price": 0,
"taxfree_price": 0,
"__v": 0,
"options": [],
"declinations": [],
"variations": [],
"is_default": true,
"taxes": [],
"discounts": [],
"test": false,
"deprecated": false,
"updated_at": "2018-03-16T15:08:38.770Z",
"created_at": "2018-03-16T15:08:38.770Z"}
A noter :
Une grande partie des infos dont vous pourriez avoir régulièrement besoin, telles que node_id, companies, shops, sera obtenue via un appel à l'API GET /v1/account/account