NOUVEAUDécouvrez des professionnels près de vous et partagez la vitrine de votre entrepriseExplorer la MarketPlace Be 2
Retour à mon espace
ASAKIM · VOS RÉGLAGES

Configuration

Choisissez ce que vous souhaitez modifier. Vous pourrez revenir ici après chaque étape.

À MODIFIER

API

Connectez vos logiciels et contrôlez leurs accès.

API · ASAKIM

Connecter mon logiciel

Créez une clé par logiciel pour cette société. Ses droits restent limités à ceux de votre compte ; elle est indépendante du jeton MCP.

Exemple de connexion

Le secret se transmet dans Authorization: Bearer, séparément de l’URL. Remplacez le paramètre du secret dans votre logiciel. Le client MCP doit accepter Streamable HTTP et un en-tête Bearer.

curl "https://www.asakim.app/api/v1/contexts" -H "Authorization: Bearer $ASAKIM_API_KEY"

Vérification de votre session…

Services API et exemples d’appel

14 services documentés à partir des contrats du serveur. L’accès est limité à la société du secret, à vos établissements et à vos droits métier.

  1. Créez votre clé API pour la société choisie ci-dessus.
  2. Appelez GET /contexts pour obtenir les identifiants de société et d’établissement.
  3. Découvrez les modules puis leurs champs, statuts et actions avec GET /modules puis GET /modules/{moduleId}.
  4. Copiez l’exemple du service voulu, renseignez les identifiants retournés et les valeurs métier. Une écriture demande un operationId unique et stable lors des nouvelles tentatives ; une modification ou suppression demande la revision actuelle.

Authentification : en-tête Authorization: Bearer avec $ASAKIM_API_KEY. Les exemples ne contiennent jamais votre secret. Le paramètre facultatif role permet de choisir un rôle déjà attribué ; le serveur refuse tout rôle non attribué.

Action sensible : l’appel retourne approval_required et un lien vers Configuration. Vous seul pouvez autoriser l’action exacte. L’agent reprend le même appel avec le même operationId et l’approvalId retourné. L’accord est consommé une seule fois, expire après 20 minutes et devient inutilisable si le périmètre de données a changé. preview_operation ou POST /operations/preview valide les effets sans sauvegarde et ne remplace pas cette confirmation.

Les paramètres des GET vont dans l’URL ; les paramètres des écritures vont dans le corps JSON. Les identifiants indiqués entre accolades appartiennent au chemin. Réponse : {data}. Erreurs : 400 paramètres, 401 secret, 403 droits, 409 révision, 429 quota. Ouvrir le contrat OpenAPI ↗

Catalogue détaillé des services API
Service et fonctionParamètresDroits et résultatAppel
GET /contexts

Sociétés et établissements autorisés

  • role · facultatifstring · choix : direction, gestionnaire, operateur, comptable, lecteur
Compte actif et société autorisée.

Société, établissements, rôles et secteurs autorisés.

Voir comment appeler ce service

Exemple cURL pour Bash ou WSL. Remplacez les valeurs d’exemple et définissez votre secret dans la variable d’environnement indiquée.

curl -X GET 'https://www.asakim.app/api/v1/contexts' \
  -H "Authorization: Bearer $ASAKIM_API_KEY"
GET /modules

Modules autorisés

  • companyId · obligatoirestring · au moins 1 caractère(s) · au plus 200 caractère(s)
  • siteId · obligatoirestring · au moins 1 caractère(s) · au plus 200 caractère(s)
  • role · facultatifstring · choix : direction, gestionnaire, operateur, comptable, lecteur
Droits de lecture des données concernées.

Modules accessibles et droits effectifs.

Voir comment appeler ce service

Exemple cURL pour Bash ou WSL. Remplacez les valeurs d’exemple et définissez votre secret dans la variable d’environnement indiquée.

curl -X GET 'https://www.asakim.app/api/v1/modules?companyId=VOTRE_SOCIETE&siteId=VOTRE_ETABLISSEMENT' \
  -H "Authorization: Bearer $ASAKIM_API_KEY"
GET /modules/{moduleId}

Champs, actions et droits du module

  • companyId · obligatoirestring · au moins 1 caractère(s) · au plus 200 caractère(s)
  • siteId · obligatoirestring · au moins 1 caractère(s) · au plus 200 caractère(s)
  • role · facultatifstring · choix : direction, gestionnaire, operateur, comptable, lecteur
  • moduleId · obligatoirestring · au moins 1 caractère(s) · au plus 200 caractère(s)
Droits de lecture des données concernées.

Champs, statuts, références et actions du module.

Voir comment appeler ce service

Exemple cURL pour Bash ou WSL. Remplacez les valeurs d’exemple et définissez votre secret dans la variable d’environnement indiquée.

curl -X GET 'https://www.asakim.app/api/v1/modules/VOTRE_MODULE?companyId=VOTRE_SOCIETE&siteId=VOTRE_ETABLISSEMENT' \
  -H "Authorization: Bearer $ASAKIM_API_KEY"
GET /modules/{moduleId}/records

Rechercher les fiches

  • companyId · obligatoirestring · au moins 1 caractère(s) · au plus 200 caractère(s)
  • siteId · obligatoirestring · au moins 1 caractère(s) · au plus 200 caractère(s)
  • role · facultatifstring · choix : direction, gestionnaire, operateur, comptable, lecteur
  • moduleId · obligatoirestring · au moins 1 caractère(s) · au plus 200 caractère(s)
  • query · facultatifstring · au plus 200 caractère(s) · défaut ""
  • limit · facultatifinteger · minimum 1 · maximum 100 · défaut 50
  • offset · facultatifinteger · minimum 0 · maximum 9007199254740991 · défaut 0
Droits de lecture des données concernées.

records, total et nextOffset pour la pagination.

Voir comment appeler ce service

Exemple cURL pour Bash ou WSL. Remplacez les valeurs d’exemple et définissez votre secret dans la variable d’environnement indiquée.

curl -X GET 'https://www.asakim.app/api/v1/modules/VOTRE_MODULE/records?companyId=VOTRE_SOCIETE&siteId=VOTRE_ETABLISSEMENT' \
  -H "Authorization: Bearer $ASAKIM_API_KEY"
GET /modules/{moduleId}/records/{recordId}

Lire une fiche

  • companyId · obligatoirestring · au moins 1 caractère(s) · au plus 200 caractère(s)
  • siteId · obligatoirestring · au moins 1 caractère(s) · au plus 200 caractère(s)
  • role · facultatifstring · choix : direction, gestionnaire, operateur, comptable, lecteur
  • moduleId · obligatoirestring · au moins 1 caractère(s) · au plus 200 caractère(s)
  • recordId · obligatoirestring · au moins 1 caractère(s) · au plus 200 caractère(s)
Droits de lecture des données concernées.

Fiche autorisée, valeurs et révision.

Voir comment appeler ce service

Exemple cURL pour Bash ou WSL. Remplacez les valeurs d’exemple et définissez votre secret dans la variable d’environnement indiquée.

curl -X GET 'https://www.asakim.app/api/v1/modules/VOTRE_MODULE/records/VOTRE_FICHE?companyId=VOTRE_SOCIETE&siteId=VOTRE_ETABLISSEMENT' \
  -H "Authorization: Bearer $ASAKIM_API_KEY"
POST /modules/{moduleId}/records

Créer une fiche

  • companyId · obligatoirestring · au moins 1 caractère(s) · au plus 200 caractère(s)
  • siteId · obligatoirestring · au moins 1 caractère(s) · au plus 200 caractère(s)
  • role · facultatifstring · choix : direction, gestionnaire, operateur, comptable, lecteur
  • moduleId · obligatoirestring · au moins 1 caractère(s) · au plus 200 caractère(s)
  • values · obligatoireobject
  • operationId · obligatoirestring · format ^[A-Za-z0-9_-]{8,200}$
  • approvalId · facultatifstring · format ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Clé d’écriture + droits métier d’écriture ou d’action.

Résultat de l’opération et identifiant operationId.

Voir comment appeler ce service

Exemple cURL pour Bash ou WSL. Remplacez les valeurs d’exemple et définissez votre secret dans la variable d’environnement indiquée.

curl -X POST 'https://www.asakim.app/api/v1/modules/VOTRE_MODULE/records' \
  -H "Authorization: Bearer $ASAKIM_API_KEY" \
  -H 'Content-Type: application/json' \
  --data '{
  "companyId": "VOTRE_SOCIETE",
  "siteId": "VOTRE_ETABLISSEMENT",
  "values": {},
  "operationId": "operation_unique_001"
}'
PATCH /modules/{moduleId}/records/{recordId}

Modifier une fiche

  • companyId · obligatoirestring · au moins 1 caractère(s) · au plus 200 caractère(s)
  • siteId · obligatoirestring · au moins 1 caractère(s) · au plus 200 caractère(s)
  • role · facultatifstring · choix : direction, gestionnaire, operateur, comptable, lecteur
  • moduleId · obligatoirestring · au moins 1 caractère(s) · au plus 200 caractère(s)
  • recordId · obligatoirestring · au moins 1 caractère(s) · au plus 200 caractère(s)
  • values · obligatoireobject
  • revision · obligatoireinteger · strictement supérieur à 0 · maximum 9007199254740991
  • operationId · obligatoirestring · format ^[A-Za-z0-9_-]{8,200}$
  • approvalId · facultatifstring · format ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Clé d’écriture + droits métier d’écriture ou d’action.

Résultat de l’opération et identifiant operationId.

Voir comment appeler ce service

Exemple cURL pour Bash ou WSL. Remplacez les valeurs d’exemple et définissez votre secret dans la variable d’environnement indiquée.

curl -X PATCH 'https://www.asakim.app/api/v1/modules/VOTRE_MODULE/records/VOTRE_FICHE' \
  -H "Authorization: Bearer $ASAKIM_API_KEY" \
  -H 'Content-Type: application/json' \
  --data '{
  "companyId": "VOTRE_SOCIETE",
  "siteId": "VOTRE_ETABLISSEMENT",
  "values": {},
  "revision": 1,
  "operationId": "operation_unique_001"
}'
DELETE /modules/{moduleId}/records/{recordId}

Supprimer une fiche

  • companyId · obligatoirestring · au moins 1 caractère(s) · au plus 200 caractère(s)
  • siteId · obligatoirestring · au moins 1 caractère(s) · au plus 200 caractère(s)
  • role · facultatifstring · choix : direction, gestionnaire, operateur, comptable, lecteur
  • moduleId · obligatoirestring · au moins 1 caractère(s) · au plus 200 caractère(s)
  • recordId · obligatoirestring · au moins 1 caractère(s) · au plus 200 caractère(s)
  • revision · obligatoireinteger · strictement supérieur à 0 · maximum 9007199254740991
  • operationId · obligatoirestring · format ^[A-Za-z0-9_-]{8,200}$
  • approvalId · facultatifstring · format ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Clé d’écriture + droits métier d’écriture ou d’action.

Résultat de l’opération et identifiant operationId.

Voir comment appeler ce service

Exemple cURL pour Bash ou WSL. Remplacez les valeurs d’exemple et définissez votre secret dans la variable d’environnement indiquée.

curl -X DELETE 'https://www.asakim.app/api/v1/modules/VOTRE_MODULE/records/VOTRE_FICHE' \
  -H "Authorization: Bearer $ASAKIM_API_KEY" \
  -H 'Content-Type: application/json' \
  --data '{
  "companyId": "VOTRE_SOCIETE",
  "siteId": "VOTRE_ETABLISSEMENT",
  "revision": 1,
  "operationId": "operation_unique_001"
}'
POST /actions

Exécuter une action métier

  • companyId · obligatoirestring · au moins 1 caractère(s) · au plus 200 caractère(s)
  • siteId · obligatoirestring · au moins 1 caractère(s) · au plus 200 caractère(s)
  • role · facultatifstring · choix : direction, gestionnaire, operateur, comptable, lecteur
  • command · obligatoireobjet
  • operationId · obligatoirestring · format ^[A-Za-z0-9_-]{8,200}$
  • approvalId · facultatifstring · format ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Clé d’écriture + droits métier d’écriture ou d’action.

Résultat de l’action et identifiant operationId.

Voir comment appeler ce service

Exemple cURL pour Bash ou WSL. Remplacez les valeurs d’exemple et définissez votre secret dans la variable d’environnement indiquée.

curl -X POST 'https://www.asakim.app/api/v1/actions' \
  -H "Authorization: Bearer $ASAKIM_API_KEY" \
  -H 'Content-Type: application/json' \
  --data '{
  "companyId": "VOTRE_SOCIETE",
  "siteId": "VOTRE_ETABLISSEMENT",
  "command": {
    "type": "transition",
    "id": "VOTRE_FICHE",
    "revision": 1,
    "status": "STATUT_AUTORISE"
  },
  "operationId": "operation_unique_001"
}'
GET /access

Lire les utilisateurs et affectations autorisés

  • companyId · obligatoirestring · au moins 1 caractère(s) · au plus 200 caractère(s)
  • siteId · obligatoirestring · au moins 1 caractère(s) · au plus 200 caractère(s)
  • role · facultatifstring · choix : direction, gestionnaire, operateur, comptable, lecteur
Direction ou gestionnaire, dans le périmètre autorisé.

Société, établissements, utilisateurs et affectations visibles dans le périmètre administratif.

Voir comment appeler ce service

Exemple cURL pour Bash ou WSL. Remplacez les valeurs d’exemple et définissez votre secret dans la variable d’environnement indiquée.

curl -X GET 'https://www.asakim.app/api/v1/access?companyId=VOTRE_SOCIETE&siteId=VOTRE_ETABLISSEMENT' \
  -H "Authorization: Bearer $ASAKIM_API_KEY"
GET /reports/accounting

Lire les sources, revues et notes comptables

  • companyId · obligatoirestring · au moins 1 caractère(s) · au plus 200 caractère(s)
  • siteId · obligatoirestring · au moins 1 caractère(s) · au plus 200 caractère(s)
  • role · facultatifstring · choix : direction, gestionnaire, operateur, comptable, lecteur
Droits de lecture des données concernées.

Sources comptables, événements de revue, réglages financiers et notes d’annexe autorisés.

Voir comment appeler ce service

Exemple cURL pour Bash ou WSL. Remplacez les valeurs d’exemple et définissez votre secret dans la variable d’environnement indiquée.

curl -X GET 'https://www.asakim.app/api/v1/reports/accounting?companyId=VOTRE_SOCIETE&siteId=VOTRE_ETABLISSEMENT' \
  -H "Authorization: Bearer $ASAKIM_API_KEY"
GET /settings/dashboards

Lire mes tableaux de bord personnels

  • companyId · obligatoirestring · au moins 1 caractère(s) · au plus 200 caractère(s)
  • siteId · obligatoirestring · au moins 1 caractère(s) · au plus 200 caractère(s)
  • role · facultatifstring · choix : direction, gestionnaire, operateur, comptable, lecteur
Droits de lecture des données concernées.

Vos réglages personnels de tableaux de bord.

Voir comment appeler ce service

Exemple cURL pour Bash ou WSL. Remplacez les valeurs d’exemple et définissez votre secret dans la variable d’environnement indiquée.

curl -X GET 'https://www.asakim.app/api/v1/settings/dashboards?companyId=VOTRE_SOCIETE&siteId=VOTRE_ETABLISSEMENT' \
  -H "Authorization: Bearer $ASAKIM_API_KEY"
POST /access

Administrer dans le périmètre de cette société

  • companyId · obligatoirestring · au moins 1 caractère(s) · au plus 200 caractère(s)
  • siteId · obligatoirestring · au moins 1 caractère(s) · au plus 200 caractère(s)
  • role · facultatifstring · choix : direction, gestionnaire, operateur, comptable, lecteur
  • entity · obligatoirestring · choix : organization, company, site, user, membership
  • data · obligatoireobject
  • operationId · obligatoirestring · format ^[A-Za-z0-9_-]{8,200}$
  • approvalId · facultatifstring · format ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Clé d’écriture + droits métier d’écriture ou d’action.

Résultat de l’administration autorisée ; accord utilisateur requis.

Voir comment appeler ce service

Exemple cURL pour Bash ou WSL. Remplacez les valeurs d’exemple et définissez votre secret dans la variable d’environnement indiquée.

curl -X POST 'https://www.asakim.app/api/v1/access' \
  -H "Authorization: Bearer $ASAKIM_API_KEY" \
  -H 'Content-Type: application/json' \
  --data '{
  "companyId": "VOTRE_SOCIETE",
  "siteId": "VOTRE_ETABLISSEMENT",
  "entity": "organization",
  "data": {},
  "operationId": "operation_unique_001"
}'
POST /operations/preview

Valider une opération sans sauvegarde

  • companyId · obligatoirestring · au moins 1 caractère(s) · au plus 200 caractère(s)
  • siteId · obligatoirestring · au moins 1 caractère(s) · au plus 200 caractère(s)
  • role · facultatifstring · choix : direction, gestionnaire, operateur, comptable, lecteur
  • command · obligatoireobjet
Clé d’écriture + droits métier d’écriture ou d’action.

valid, persisted:false, workspaceRevision, sensitive et changements prévus. Aucun enregistrement.

Voir comment appeler ce service

Exemple cURL pour Bash ou WSL. Remplacez les valeurs d’exemple et définissez votre secret dans la variable d’environnement indiquée.

curl -X POST 'https://www.asakim.app/api/v1/operations/preview' \
  -H "Authorization: Bearer $ASAKIM_API_KEY" \
  -H 'Content-Type: application/json' \
  --data '{
  "companyId": "VOTRE_SOCIETE",
  "siteId": "VOTRE_ETABLISSEMENT",
  "command": {
    "type": "transition",
    "id": "VOTRE_FICHE",
    "revision": 1,
    "status": "STATUT_AUTORISE"
  }
}'
Voir les 28 actions métier et leurs appels

Ces commandes passent par POST /actions. Le champ command.type choisit l’action. Les possibilités de chaque module sont données par GET /modules/{moduleId} ; le moteur vérifie les droits et l’état de la fiche. Les commandes de caisse ne déclenchent pas un règlement auprès d’un prestataire.

transition · Changer le statut d’une fiche
  • id · obligatoire · string · au moins 1 caractère(s) · au plus 200 caractère(s)
  • revision · obligatoire · integer · strictement supérieur à 0 · maximum 9007199254740991
  • status · obligatoire · string · au moins 1 caractère(s)
Voir comment appeler ce service

Exemple cURL pour Bash ou WSL. Remplacez les valeurs d’exemple et définissez votre secret dans la variable d’environnement indiquée.

curl -X POST 'https://www.asakim.app/api/v1/actions' \
  -H "Authorization: Bearer $ASAKIM_API_KEY" \
  -H 'Content-Type: application/json' \
  --data '{
  "companyId": "VOTRE_SOCIETE",
  "siteId": "VOTRE_ETABLISSEMENT",
  "command": {
    "type": "transition",
    "id": "VOTRE_FICHE",
    "revision": 1,
    "status": "STATUT_AUTORISE"
  },
  "operationId": "operation_unique_001"
}'
comment · Ajouter un commentaire
  • id · obligatoire · string · au moins 1 caractère(s) · au plus 200 caractère(s)
  • text · obligatoire · string · au moins 1 caractère(s) · au plus 10000 caractère(s)
Voir comment appeler ce service

Exemple cURL pour Bash ou WSL. Remplacez les valeurs d’exemple et définissez votre secret dans la variable d’environnement indiquée.

curl -X POST 'https://www.asakim.app/api/v1/actions' \
  -H "Authorization: Bearer $ASAKIM_API_KEY" \
  -H 'Content-Type: application/json' \
  --data '{
  "companyId": "VOTRE_SOCIETE",
  "siteId": "VOTRE_ETABLISSEMENT",
  "command": {
    "type": "comment",
    "id": "VOTRE_FICHE",
    "text": "Commentaire de suivi"
  },
  "operationId": "operation_unique_001"
}'
attachment · Joindre un document
  • id · obligatoire · string · au moins 1 caractère(s) · au plus 200 caractère(s)
  • name · obligatoire · string · au moins 1 caractère(s)
  • data · obligatoire · string · au plus 4000000 caractère(s)
Voir comment appeler ce service

Exemple cURL pour Bash ou WSL. Remplacez les valeurs d’exemple et définissez votre secret dans la variable d’environnement indiquée.

curl -X POST 'https://www.asakim.app/api/v1/actions' \
  -H "Authorization: Bearer $ASAKIM_API_KEY" \
  -H 'Content-Type: application/json' \
  --data '{
  "companyId": "VOTRE_SOCIETE",
  "siteId": "VOTRE_ETABLISSEMENT",
  "command": {
    "type": "attachment",
    "id": "VOTRE_FICHE",
    "name": "Nom exemple",
    "data": "EXEMPLE_A_ADAPTER"
  },
  "operationId": "operation_unique_001"
}'
sale · Enregistrer une vente
  • lines · obligatoire · array · au moins 1 élément(s) · au plus 1000 élément(s)
    • productId · obligatoire · string · au moins 1 caractère(s) · au plus 200 caractère(s)
    • quantity · obligatoire · number · strictement supérieur à 0
    • unitPrice · obligatoire · number · minimum 0
  • cash · obligatoire · number · minimum 0
  • mobile · obligatoire · number · minimum 0
  • card · obligatoire · number · minimum 0
  • customer · obligatoire · string
  • discount · obligatoire · number · minimum 0
Voir comment appeler ce service

Exemple cURL pour Bash ou WSL. Remplacez les valeurs d’exemple et définissez votre secret dans la variable d’environnement indiquée.

curl -X POST 'https://www.asakim.app/api/v1/actions' \
  -H "Authorization: Bearer $ASAKIM_API_KEY" \
  -H 'Content-Type: application/json' \
  --data '{
  "companyId": "VOTRE_SOCIETE",
  "siteId": "VOTRE_ETABLISSEMENT",
  "command": {
    "type": "sale",
    "lines": [
      {
        "productId": "EXEMPLE_A_ADAPTER",
        "quantity": 1,
        "unitPrice": 0
      }
    ],
    "cash": 0,
    "mobile": 0,
    "card": 0,
    "customer": "EXEMPLE_A_ADAPTER",
    "discount": 0
  },
  "operationId": "operation_unique_001"
}'
payment · Enregistrer un paiement métier
  • id · obligatoire · string · au moins 1 caractère(s) · au plus 200 caractère(s)
  • amount · obligatoire · number · strictement supérieur à 0
  • method · obligatoire · string · au moins 1 caractère(s)
Voir comment appeler ce service

Exemple cURL pour Bash ou WSL. Remplacez les valeurs d’exemple et définissez votre secret dans la variable d’environnement indiquée.

curl -X POST 'https://www.asakim.app/api/v1/actions' \
  -H "Authorization: Bearer $ASAKIM_API_KEY" \
  -H 'Content-Type: application/json' \
  --data '{
  "companyId": "VOTRE_SOCIETE",
  "siteId": "VOTRE_ETABLISSEMENT",
  "command": {
    "type": "payment",
    "id": "VOTRE_FICHE",
    "amount": 1,
    "method": "EXEMPLE_A_ADAPTER"
  },
  "operationId": "operation_unique_001"
}'
purchase-payment · Enregistrer un règlement fournisseur après réception
  • id · obligatoire · string · au moins 1 caractère(s) · au plus 200 caractère(s)
  • amount · obligatoire · integer · strictement supérieur à 0 · maximum 9007199254740991
  • method · obligatoire · string · choix : Espèces, Mobile Money simulé, Carte simulée, Virement simulé
Voir comment appeler ce service

Exemple cURL pour Bash ou WSL. Remplacez les valeurs d’exemple et définissez votre secret dans la variable d’environnement indiquée.

curl -X POST 'https://www.asakim.app/api/v1/actions' \
  -H "Authorization: Bearer $ASAKIM_API_KEY" \
  -H 'Content-Type: application/json' \
  --data '{
  "companyId": "VOTRE_SOCIETE",
  "siteId": "VOTRE_ETABLISSEMENT",
  "command": {
    "type": "purchase-payment",
    "id": "VOTRE_FICHE",
    "amount": 1,
    "method": "Espèces"
  },
  "operationId": "operation_unique_001"
}'
dashboard · Configurer mes cartes et graphiques de tableau de bord
  • sector · obligatoire · string · au moins 1 caractère(s) · au plus 200 caractère(s)
  • cards · obligatoire · array · au plus 12 élément(s)
    • id · obligatoire · string · format ^[a-zA-Z0-9_-]{1,50}$
    • title · obligatoire · string · au moins 1 caractère(s) · au plus 80 caractère(s)
    • kind · obligatoire · string · choix : kpi, chart
    • moduleId · obligatoire · string · au moins 1 caractère(s) · au plus 200 caractère(s)
    • measure · obligatoire · string · choix : count, sum, balance
    • field · facultatif · string · au moins 1 caractère(s) · au plus 200 caractère(s)
    • chartType · facultatif · string · choix : bar, line
Voir comment appeler ce service

Exemple cURL pour Bash ou WSL. Remplacez les valeurs d’exemple et définissez votre secret dans la variable d’environnement indiquée.

curl -X POST 'https://www.asakim.app/api/v1/actions' \
  -H "Authorization: Bearer $ASAKIM_API_KEY" \
  -H 'Content-Type: application/json' \
  --data '{
  "companyId": "VOTRE_SOCIETE",
  "siteId": "VOTRE_ETABLISSEMENT",
  "command": {
    "type": "dashboard",
    "sector": "EXEMPLE_A_ADAPTER",
    "cards": []
  },
  "operationId": "operation_unique_001"
}'
refund · Enregistrer un remboursement métier
  • id · obligatoire · string · au moins 1 caractère(s) · au plus 200 caractère(s)
Voir comment appeler ce service

Exemple cURL pour Bash ou WSL. Remplacez les valeurs d’exemple et définissez votre secret dans la variable d’environnement indiquée.

curl -X POST 'https://www.asakim.app/api/v1/actions' \
  -H "Authorization: Bearer $ASAKIM_API_KEY" \
  -H 'Content-Type: application/json' \
  --data '{
  "companyId": "VOTRE_SOCIETE",
  "siteId": "VOTRE_ETABLISSEMENT",
  "command": {
    "type": "refund",
    "id": "VOTRE_FICHE"
  },
  "operationId": "operation_unique_001"
}'
close-register · Clôturer la caisse
  • counted · obligatoire · number · minimum 0
Voir comment appeler ce service

Exemple cURL pour Bash ou WSL. Remplacez les valeurs d’exemple et définissez votre secret dans la variable d’environnement indiquée.

curl -X POST 'https://www.asakim.app/api/v1/actions' \
  -H "Authorization: Bearer $ASAKIM_API_KEY" \
  -H 'Content-Type: application/json' \
  --data '{
  "companyId": "VOTRE_SOCIETE",
  "siteId": "VOTRE_ETABLISSEMENT",
  "command": {
    "type": "close-register",
    "counted": 0
  },
  "operationId": "operation_unique_001"
}'
transfer · Transférer du stock vers un établissement
  • id · obligatoire · string · au moins 1 caractère(s) · au plus 200 caractère(s)
  • quantity · obligatoire · number · strictement supérieur à 0
  • targetSiteId · obligatoire · string · au moins 1 caractère(s) · au plus 200 caractère(s)
Voir comment appeler ce service

Exemple cURL pour Bash ou WSL. Remplacez les valeurs d’exemple et définissez votre secret dans la variable d’environnement indiquée.

curl -X POST 'https://www.asakim.app/api/v1/actions' \
  -H "Authorization: Bearer $ASAKIM_API_KEY" \
  -H 'Content-Type: application/json' \
  --data '{
  "companyId": "VOTRE_SOCIETE",
  "siteId": "VOTRE_ETABLISSEMENT",
  "command": {
    "type": "transfer",
    "id": "VOTRE_FICHE",
    "quantity": 1,
    "targetSiteId": "EXEMPLE_A_ADAPTER"
  },
  "operationId": "operation_unique_001"
}'
reconcile · Rapprocher une fiche
  • id · obligatoire · string · au moins 1 caractère(s) · au plus 200 caractère(s)
Voir comment appeler ce service

Exemple cURL pour Bash ou WSL. Remplacez les valeurs d’exemple et définissez votre secret dans la variable d’environnement indiquée.

curl -X POST 'https://www.asakim.app/api/v1/actions' \
  -H "Authorization: Bearer $ASAKIM_API_KEY" \
  -H 'Content-Type: application/json' \
  --data '{
  "companyId": "VOTRE_SOCIETE",
  "siteId": "VOTRE_ETABLISSEMENT",
  "command": {
    "type": "reconcile",
    "id": "VOTRE_FICHE"
  },
  "operationId": "operation_unique_001"
}'
flag-posting · Signaler une anomalie comptable
  • id · obligatoire · string · au moins 1 caractère(s) · au plus 200 caractère(s)
  • revision · obligatoire · integer · strictement supérieur à 0 · maximum 9007199254740991
  • reason · obligatoire · string · au moins 3 caractère(s) · au plus 2000 caractère(s)
Voir comment appeler ce service

Exemple cURL pour Bash ou WSL. Remplacez les valeurs d’exemple et définissez votre secret dans la variable d’environnement indiquée.

curl -X POST 'https://www.asakim.app/api/v1/actions' \
  -H "Authorization: Bearer $ASAKIM_API_KEY" \
  -H 'Content-Type: application/json' \
  --data '{
  "companyId": "VOTRE_SOCIETE",
  "siteId": "VOTRE_ETABLISSEMENT",
  "command": {
    "type": "flag-posting",
    "id": "VOTRE_FICHE",
    "revision": 1,
    "reason": "Vérification de la pièce source"
  },
  "operationId": "operation_unique_001"
}'
resolve-posting · Résoudre une anomalie comptable
  • id · obligatoire · string · au moins 1 caractère(s) · au plus 200 caractère(s)
  • revision · obligatoire · integer · strictement supérieur à 0 · maximum 9007199254740991
  • resolution · obligatoire · string · au moins 3 caractère(s) · au plus 2000 caractère(s)
Voir comment appeler ce service

Exemple cURL pour Bash ou WSL. Remplacez les valeurs d’exemple et définissez votre secret dans la variable d’environnement indiquée.

curl -X POST 'https://www.asakim.app/api/v1/actions' \
  -H "Authorization: Bearer $ASAKIM_API_KEY" \
  -H 'Content-Type: application/json' \
  --data '{
  "companyId": "VOTRE_SOCIETE",
  "siteId": "VOTRE_ETABLISSEMENT",
  "command": {
    "type": "resolve-posting",
    "id": "VOTRE_FICHE",
    "revision": 1,
    "resolution": "Pièce source vérifiée"
  },
  "operationId": "operation_unique_001"
}'
review-posting · Vérifier les quatre contrôles d’une écriture
  • id · obligatoire · string · au moins 1 caractère(s) · au plus 200 caractère(s)
  • revision · obligatoire · integer · strictement supérieur à 0 · maximum 9007199254740991
  • checks · obligatoire · array · au moins 4 élément(s) · au plus 4 élément(s)
Voir comment appeler ce service

Exemple cURL pour Bash ou WSL. Remplacez les valeurs d’exemple et définissez votre secret dans la variable d’environnement indiquée.

curl -X POST 'https://www.asakim.app/api/v1/actions' \
  -H "Authorization: Bearer $ASAKIM_API_KEY" \
  -H 'Content-Type: application/json' \
  --data '{
  "companyId": "VOTRE_SOCIETE",
  "siteId": "VOTRE_ETABLISSEMENT",
  "command": {
    "type": "review-posting",
    "id": "VOTRE_FICHE",
    "revision": 1,
    "checks": [
      "source",
      "accounts",
      "amounts",
      "period"
    ]
  },
  "operationId": "operation_unique_001"
}'
close-period · Clôturer une période comptable
  • period · obligatoire · string · format ^\d{4}-(0[1-9]|1[0-2])$
Voir comment appeler ce service

Exemple cURL pour Bash ou WSL. Remplacez les valeurs d’exemple et définissez votre secret dans la variable d’environnement indiquée.

curl -X POST 'https://www.asakim.app/api/v1/actions' \
  -H "Authorization: Bearer $ASAKIM_API_KEY" \
  -H 'Content-Type: application/json' \
  --data '{
  "companyId": "VOTRE_SOCIETE",
  "siteId": "VOTRE_ETABLISSEMENT",
  "command": {
    "type": "close-period",
    "period": "2026-10"
  },
  "operationId": "operation_unique_001"
}'
financial-dashboard · Configurer les indicateurs et graphiques financiers
  • view · obligatoire · string · choix : accounting, finance
  • metrics · obligatoire · array · au plus 16 élément(s)
  • cards · facultatif · array · au plus 24 élément(s)
    • id · obligatoire · string · format ^[a-zA-Z0-9-]{1,80}$
    • title · obligatoire · string · au moins 1 caractère(s) · au plus 80 caractère(s)
    • metric · obligatoire · string · choix : postings, reviewed, unreviewed, drafts, exceptions, sourceGaps, debit, credit, income, expenses, result, treasury, positionGap, taxes, vat, quarterlyVat
  • charts · facultatif · array · au plus 24 élément(s)
    • id · facultatif · string · format ^[a-zA-Z0-9-]{1,80}$
    • title · facultatif · string · au moins 1 caractère(s) · au plus 80 caractère(s)
    • metric · obligatoire · string · choix : postings, reviewed, unreviewed, drafts, exceptions, sourceGaps, debit, credit, income, expenses, result, treasury, positionGap, taxes, vat, quarterlyVat
    • type · obligatoire · string · choix : bar, line
Voir comment appeler ce service

Exemple cURL pour Bash ou WSL. Remplacez les valeurs d’exemple et définissez votre secret dans la variable d’environnement indiquée.

curl -X POST 'https://www.asakim.app/api/v1/actions' \
  -H "Authorization: Bearer $ASAKIM_API_KEY" \
  -H 'Content-Type: application/json' \
  --data '{
  "companyId": "VOTRE_SOCIETE",
  "siteId": "VOTRE_ETABLISSEMENT",
  "command": {
    "type": "financial-dashboard",
    "view": "accounting",
    "metrics": []
  },
  "operationId": "operation_unique_001"
}'
financial-report-note · Enregistrer les notes d’annexe annuelles
  • period · obligatoire · string · format ^\d{4}$
  • siteIds · obligatoire · array · au moins 1 élément(s) · au plus 100 élément(s)
  • values · obligatoire · object
    • accountingMethods · obligatoire · string · au plus 2000 caractère(s)
    • inventory · obligatoire · string · au plus 2000 caractère(s)
    • depreciation · obligatoire · string · au plus 2000 caractère(s)
    • provisions · obligatoire · string · au plus 2000 caractère(s)
    • commitments · obligatoire · string · au plus 2000 caractère(s)
    • subsequentEvents · obligatoire · string · au plus 2000 caractère(s)
    • comparative · obligatoire · string · au plus 2000 caractère(s)
Voir comment appeler ce service

Exemple cURL pour Bash ou WSL. Remplacez les valeurs d’exemple et définissez votre secret dans la variable d’environnement indiquée.

curl -X POST 'https://www.asakim.app/api/v1/actions' \
  -H "Authorization: Bearer $ASAKIM_API_KEY" \
  -H 'Content-Type: application/json' \
  --data '{
  "companyId": "VOTRE_SOCIETE",
  "siteId": "VOTRE_ETABLISSEMENT",
  "command": {
    "type": "financial-report-note",
    "period": "2026",
    "siteIds": [
      "EXEMPLE_A_ADAPTER"
    ],
    "values": {
      "accountingMethods": "EXEMPLE_A_ADAPTER",
      "inventory": "EXEMPLE_A_ADAPTER",
      "depreciation": "EXEMPLE_A_ADAPTER",
      "provisions": "EXEMPLE_A_ADAPTER",
      "commitments": "EXEMPLE_A_ADAPTER",
      "subsequentEvents": "EXEMPLE_A_ADAPTER",
      "comparative": "EXEMPLE_A_ADAPTER"
    }
  },
  "operationId": "operation_unique_001"
}'
pos-bootstrap · Initialiser les terminaux de démonstration · démonstration uniquement, refusé en production
    Voir comment appeler ce service

    Exemple cURL pour Bash ou WSL. Remplacez les valeurs d’exemple et définissez votre secret dans la variable d’environnement indiquée.

    curl -X POST 'https://www.asakim.app/api/v1/actions' \
  -H "Authorization: Bearer $ASAKIM_API_KEY" \
  -H 'Content-Type: application/json' \
  --data '{
  "companyId": "VOTRE_SOCIETE",
  "siteId": "VOTRE_ETABLISSEMENT",
  "command": {
    "type": "pos-bootstrap"
  },
  "operationId": "operation_unique_001"
}'
    pos-terminal · Configurer un terminal virtuel
    • id · facultatif · string · au moins 1 caractère(s) · au plus 200 caractère(s)
    • name · obligatoire · string · au moins 1 caractère(s) · au plus 250 caractère(s)
    • endpointIds · obligatoire · array · au plus 30 élément(s)
    • active · obligatoire · boolean
    • openingCash · obligatoire · integer · minimum 0 · maximum 9007199254740991
    Voir comment appeler ce service

    Exemple cURL pour Bash ou WSL. Remplacez les valeurs d’exemple et définissez votre secret dans la variable d’environnement indiquée.

    curl -X POST 'https://www.asakim.app/api/v1/actions' \
  -H "Authorization: Bearer $ASAKIM_API_KEY" \
  -H 'Content-Type: application/json' \
  --data '{
  "companyId": "VOTRE_SOCIETE",
  "siteId": "VOTRE_ETABLISSEMENT",
  "command": {
    "type": "pos-terminal",
    "name": "Nom exemple",
    "endpointIds": [],
    "active": true,
    "openingCash": 0
  },
  "operationId": "operation_unique_001"
}'
    pos-endpoint · Configurer un point d’encaissement
    • id · facultatif · string · au moins 1 caractère(s) · au plus 200 caractère(s)
    • name · obligatoire · string · au moins 1 caractère(s) · au plus 250 caractère(s)
    • provider · obligatoire · string · choix : orange, mtn, moov, wave
    • merchantReference · obligatoire · string · au moins 1 caractère(s) · au plus 250 caractère(s)
    • active · obligatoire · boolean
    Voir comment appeler ce service

    Exemple cURL pour Bash ou WSL. Remplacez les valeurs d’exemple et définissez votre secret dans la variable d’environnement indiquée.

    curl -X POST 'https://www.asakim.app/api/v1/actions' \
  -H "Authorization: Bearer $ASAKIM_API_KEY" \
  -H 'Content-Type: application/json' \
  --data '{
  "companyId": "VOTRE_SOCIETE",
  "siteId": "VOTRE_ETABLISSEMENT",
  "command": {
    "type": "pos-endpoint",
    "name": "Nom exemple",
    "provider": "orange",
    "merchantReference": "EXEMPLE_A_ADAPTER",
    "active": true
  },
  "operationId": "operation_unique_001"
}'
    pos-cart · Créer ou modifier un panier
    • id · facultatif · string · au moins 1 caractère(s) · au plus 200 caractère(s)
    • revision · facultatif · integer · strictement supérieur à 0 · maximum 9007199254740991
    • terminalId · obligatoire · string · au moins 1 caractère(s) · au plus 200 caractère(s)
    • lines · obligatoire · array · au moins 1 élément(s) · au plus 500 élément(s)
      • productId · obligatoire · string · au moins 1 caractère(s) · au plus 200 caractère(s)
      • quantity · obligatoire · number · strictement supérieur à 0
      • unitPrice · obligatoire · integer · minimum 0 · maximum 9007199254740991
    • customer · obligatoire · string · au plus 250 caractère(s)
    • discount · obligatoire · integer · minimum 0 · maximum 9007199254740991
    Voir comment appeler ce service

    Exemple cURL pour Bash ou WSL. Remplacez les valeurs d’exemple et définissez votre secret dans la variable d’environnement indiquée.

    curl -X POST 'https://www.asakim.app/api/v1/actions' \
  -H "Authorization: Bearer $ASAKIM_API_KEY" \
  -H 'Content-Type: application/json' \
  --data '{
  "companyId": "VOTRE_SOCIETE",
  "siteId": "VOTRE_ETABLISSEMENT",
  "command": {
    "type": "pos-cart",
    "terminalId": "EXEMPLE_A_ADAPTER",
    "lines": [
      {
        "productId": "EXEMPLE_A_ADAPTER",
        "quantity": 1,
        "unitPrice": 0
      }
    ],
    "customer": "EXEMPLE_A_ADAPTER",
    "discount": 0
  },
  "operationId": "operation_unique_001"
}'
    pos-prepare · Préparer la répartition du règlement
    • id · obligatoire · string · au moins 1 caractère(s) · au plus 200 caractère(s)
    • revision · obligatoire · integer · strictement supérieur à 0 · maximum 9007199254740991
    • cash · obligatoire · integer · minimum 0 · maximum 9007199254740991
    • card · obligatoire · integer · minimum 0 · maximum 9007199254740991
    • mobile · obligatoire · array · au plus 30 élément(s)
      • endpointId · obligatoire · string · au moins 1 caractère(s) · au plus 200 caractère(s)
      • amount · obligatoire · integer · strictement supérieur à 0 · maximum 9007199254740991
    • allowCredit · obligatoire · boolean
    Voir comment appeler ce service

    Exemple cURL pour Bash ou WSL. Remplacez les valeurs d’exemple et définissez votre secret dans la variable d’environnement indiquée.

    curl -X POST 'https://www.asakim.app/api/v1/actions' \
  -H "Authorization: Bearer $ASAKIM_API_KEY" \
  -H 'Content-Type: application/json' \
  --data '{
  "companyId": "VOTRE_SOCIETE",
  "siteId": "VOTRE_ETABLISSEMENT",
  "command": {
    "type": "pos-prepare",
    "id": "VOTRE_FICHE",
    "revision": 1,
    "cash": 0,
    "card": 0,
    "mobile": [],
    "allowCredit": true
  },
  "operationId": "operation_unique_001"
}'
    pos-outcome · Enregistrer une issue simulée du règlement
    • id · obligatoire · string · au moins 1 caractère(s) · au plus 200 caractère(s)
    • outcome · obligatoire · string · choix : authorized, refused, expired
    Voir comment appeler ce service

    Exemple cURL pour Bash ou WSL. Remplacez les valeurs d’exemple et définissez votre secret dans la variable d’environnement indiquée.

    curl -X POST 'https://www.asakim.app/api/v1/actions' \
  -H "Authorization: Bearer $ASAKIM_API_KEY" \
  -H 'Content-Type: application/json' \
  --data '{
  "companyId": "VOTRE_SOCIETE",
  "siteId": "VOTRE_ETABLISSEMENT",
  "command": {
    "type": "pos-outcome",
    "id": "VOTRE_FICHE",
    "outcome": "authorized"
  },
  "operationId": "operation_unique_001"
}'
    pos-retry · Relancer une tentative de caisse
    • id · obligatoire · string · au moins 1 caractère(s) · au plus 200 caractère(s)
    Voir comment appeler ce service

    Exemple cURL pour Bash ou WSL. Remplacez les valeurs d’exemple et définissez votre secret dans la variable d’environnement indiquée.

    curl -X POST 'https://www.asakim.app/api/v1/actions' \
  -H "Authorization: Bearer $ASAKIM_API_KEY" \
  -H 'Content-Type: application/json' \
  --data '{
  "companyId": "VOTRE_SOCIETE",
  "siteId": "VOTRE_ETABLISSEMENT",
  "command": {
    "type": "pos-retry",
    "id": "VOTRE_FICHE"
  },
  "operationId": "operation_unique_001"
}'
    pos-finalize · Finaliser un ticket autorisé
    • id · obligatoire · string · au moins 1 caractère(s) · au plus 200 caractère(s)
    Voir comment appeler ce service

    Exemple cURL pour Bash ou WSL. Remplacez les valeurs d’exemple et définissez votre secret dans la variable d’environnement indiquée.

    curl -X POST 'https://www.asakim.app/api/v1/actions' \
  -H "Authorization: Bearer $ASAKIM_API_KEY" \
  -H 'Content-Type: application/json' \
  --data '{
  "companyId": "VOTRE_SOCIETE",
  "siteId": "VOTRE_ETABLISSEMENT",
  "command": {
    "type": "pos-finalize",
    "id": "VOTRE_FICHE"
  },
  "operationId": "operation_unique_001"
}'
    pos-cancel · Annuler un ticket
    • id · obligatoire · string · au moins 1 caractère(s) · au plus 200 caractère(s)
    Voir comment appeler ce service

    Exemple cURL pour Bash ou WSL. Remplacez les valeurs d’exemple et définissez votre secret dans la variable d’environnement indiquée.

    curl -X POST 'https://www.asakim.app/api/v1/actions' \
  -H "Authorization: Bearer $ASAKIM_API_KEY" \
  -H 'Content-Type: application/json' \
  --data '{
  "companyId": "VOTRE_SOCIETE",
  "siteId": "VOTRE_ETABLISSEMENT",
  "command": {
    "type": "pos-cancel",
    "id": "VOTRE_FICHE"
  },
  "operationId": "operation_unique_001"
}'
    pos-refund · Enregistrer le remboursement d’un ticket
    • id · obligatoire · string · au moins 1 caractère(s) · au plus 200 caractère(s)
    Voir comment appeler ce service

    Exemple cURL pour Bash ou WSL. Remplacez les valeurs d’exemple et définissez votre secret dans la variable d’environnement indiquée.

    curl -X POST 'https://www.asakim.app/api/v1/actions' \
  -H "Authorization: Bearer $ASAKIM_API_KEY" \
  -H 'Content-Type: application/json' \
  --data '{
  "companyId": "VOTRE_SOCIETE",
  "siteId": "VOTRE_ETABLISSEMENT",
  "command": {
    "type": "pos-refund",
    "id": "VOTRE_FICHE"
  },
  "operationId": "operation_unique_001"
}'
    pos-close · Clôturer un terminal virtuel
    • terminalId · obligatoire · string · au moins 1 caractère(s) · au plus 200 caractère(s)
    • counted · obligatoire · integer · minimum 0 · maximum 9007199254740991
    Voir comment appeler ce service

    Exemple cURL pour Bash ou WSL. Remplacez les valeurs d’exemple et définissez votre secret dans la variable d’environnement indiquée.

    curl -X POST 'https://www.asakim.app/api/v1/actions' \
  -H "Authorization: Bearer $ASAKIM_API_KEY" \
  -H 'Content-Type: application/json' \
  --data '{
  "companyId": "VOTRE_SOCIETE",
  "siteId": "VOTRE_ETABLISSEMENT",
  "command": {
    "type": "pos-close",
    "terminalId": "EXEMPLE_A_ADAPTER",
    "counted": 0
  },
  "operationId": "operation_unique_001"
}'

    Pagination : 100 fiches maximum, 50 par défaut ; utilisez nextOffset pour la page suivante. Quota : 120 appels par minute et par secret. Les données de création values dépendent des champs obligatoires du module : remplissez-les avant l’appel.

    Configuration | Asakim