L'API CicaPay est une JSON REST API qui donne accès à nos services et à nos informations aux marchands. Si vous souhaitez avoir une fonction paticulière ajoutée, veuillez suivre le lien de contact pour nous joindre. Les appels API sont implémentés en tant qu'appels HTTP (application/json) vers nos endpoints.

Configuration de l'API

La seule configuration nécéssaire consiste à accéder à la page API KEYS sur votre dashboard.
- Choisir le mode ( TEST / LIVE ) il est important de bien choisir le mode, une clé généré en mode TEST ne pourra lancé que les requêtes TEST
- Vous recevrez une clé privée . Assurez-vous de ne pas partager votre clé API avec des tiers.
- Vous avez une limite de 10 clés Maximum ( TEST et LIVE )

Authentification

Chaque appel API a une signature HMAC SHA-512 générée avec votre clé. Notre serveur génère sa propre signature HMAC et la compare avec celle de l'appelant de l'API. S'ils ne correspondent pas, l'appel API est ignoré ou retourne une erreur. La signature HMAC est envoyée sous la forme d'un en-tête HTTP appelé 'HMAC'.

La signature HMAC est créee à partir des données brutes complètes de votre requête.

Réponse API

L'API retourne un tableau et ou un object au format JSON ( consulter la réponse par requête) en fonction de la requête.
- En cas d'erreur, l'API retourne un object "error": "message" , - En cas de succès, si il y a des données à vous renvoyer, ils seront envoyés dans un tableau/object en fonction de la requete.

Champs de l'API

Les appels d'API sont éffectués en tant que requêtes HTTP de base à l'aide des variables suivantes : (remarque : les données POST sont des données de style application/json ou x-www-form-urlencoded)

Nom de domaine	Description	Requis ?
mode	test / live	Oui
request	l'API que vous appelez	Oui
clé	Votre clé API	Oui