> ## Documentation Index
> Fetch the complete documentation index at: https://docs.yiksipay.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Introduction

> Apprenez a integrer nos API de maniere fluide dans votre application.

<Note>
  Avant de commencer !<br />
  Vous devriez creer un compte Yiksi Pay gratuit que vous pouvez utiliser pour tester l'API. Nous vous fournirons des cles de test que vous pouvez utiliser pour effectuer des appels API.
</Note>

L'API Yiksi Pay vous donne acces a pratiquement toutes les fonctionnalites que vous pouvez utiliser sur notre tableau de bord et vous permet de les etendre pour une utilisation dans votre application. Elle s'efforce d'etre RESTful et est organisee autour des principales ressources avec lesquelles vous interagirez - avec quelques exceptions notables.

### Exemples de Requetes

Nous fournissons des exemples d'appels API a cote de chaque methode [en utilisant cURL](https://curl.se/). Tout ce que vous avez a faire est d'inserer vos parametres specifiques, et vous pouvez tester les appels depuis la ligne de commande. Consultez ce tutoriel sur [l'utilisation de cURL avec les API](https://www.baeldung.com/curl-rest).

Vous pouvez egalement [utiliser Postman](https://www.postman.com/downloads/) si vous n'etes pas familier avec cURL. Postman est une plateforme de developpement et de test d'API facile a utiliser. Vous pouvez explorer la [Collection Postman Yiksi Pay](https://www.postman.com/winter-moon-201761/yiksi-pay-api/collection/52598694-2844112a-6a69-4035-8b27-aa1f2bb12b89/?action=share\&creator=0) pour comprendre comment fonctionnent nos API.

### Requetes et Reponses

Les donnees du corps de requete et les donnees de reponse sont formatees en JSON. Le type de contenu pour les reponses sera toujours application/json. Generalement, toutes les reponses seront dans le format suivant :

```json theme={null}
{
  "statusCode": "[number]",
  "message": "[string]",
  "data": "[object]"
}
```

### Cles

| Propriete  | Type   | Description                                                                                                                                                                                                                                                                                                                                                              |
| ---------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| statusCode | number | C'est le code de statut de la requete qui vous permet de savoir si votre requete a reussi ou non. Nous recommandons d'utiliser ceci pour determiner le resultat d'un appel API.                                                                                                                                                                                          |
| message    | string | C'est un resume de la reponse et de son statut. Par exemple, lors de la recuperation d'une liste de clients, le message pourrait indiquer "Transactions fetched successfully". En cas d'erreur, la cle message contiendra une description de l'erreur comme dans la situation d'en-tete d'autorisation ci-dessus. C'est la seule cle universelle a travers les requetes. |
| data       | object | Cela contient les resultats de votre requete. Cela peut etre soit un objet, soit un tableau selon la requete effectuee. Par exemple, une requete pour recuperer une seule transaction retournera un objet transaction dans la cle data, tandis que la cle serait un tableau de transactions si une liste est demandee a la place.                                        |

### Objet Meta

La cle meta est utilisee pour fournir un contexte pour le contenu de la cle data. Par exemple, si une liste de transactions effectuees par un client est recuperee, des parametres de pagination peuvent etre passes pour limiter l'ensemble de resultats. La cle meta contiendra alors un objet avec les attributs suivants :

```json theme={null}
{
 "meta": {
    "totalItems": 704,
    "itemCount": 100,
    "itemsPerPage": 100,
    "totalPages": 8,
    "currentPage": 1
  }
}
```

| Propriete    | Description                                                                                                                         |
| ------------ | ----------------------------------------------------------------------------------------------------------------------------------- |
| totalItems   | Le nombre total d'elements disponibles. Cela represente le compte complet d'elements sur toutes les pages.                          |
| itemCount    | Le nombre d'elements sur la page actuelle. Cela indique combien d'elements sont retournes dans la reponse actuelle.                 |
| itemsPerPage | Le nombre maximum d'elements par page. Cela definit la limite de pagination definie pour chaque page. **Par defaut : 100**          |
| totalPages   | Le nombre total de pages disponibles. Cela est calcule en fonction du nombre total d'elements et du nombre d'elements par page.     |
| currentPage  | Le numero de la page actuelle. Cela indique quelle page de la pagination est retournee dans la reponse actuelle. **Par defaut : 1** |