InstafuelInstafuel
FREN
  • Guides
  • Référence
  • Référence API
Guides
  • Démarrage rapide
  • Clés d'API
  • Référence API
Référence
  • Codes d'erreur
  • Glossaire
  • English
Environnement
  • Staging — instafuel-backend-staging.up.railway.app

© Instafuel — Abidjan, Côte d'Ivoire

Information
Identité
    Identité de la cléget
Entreprises
    Lister les entreprises du portefeuillegetDemander l'enrôlement d'une entreprisepostLire une entreprisegetMettre à jour une entreprisepatch
Comptes
    Lister les comptes web d'une entreprisegetCréer un compte web chez une entreprise clientepostMettre à jour un compte webpatch
Wallet
    Solde du wallet d'une entreprisegetÉcritures du walletgetTéléverser une preuve de versementpostDéclarer un versement à créditerpostSoldes de tout le portefeuillegetSuivre vos déclarations de versementgetLire une déclaration de versementget
Transactions
    Lister les pleins du portefeuillegetLire un pleinget
Chauffeurs
    Portefeuilles chauffeursget
Alertes
    Alertes des entreprises du portefeuilleget
Rapports
    Synthèse du portefeuilleget
Schemas
powered by Zudoku
API partenaire Instafuel
API partenaire Instafuel

Comptes

Download schema

Comptes web des entreprises clientes (pilotage de flotte).


Lister les comptes web d'une entreprise

GET
https://instafuel-backend-staging.up.railway.app
/v1/papi/companies/{companyId}/users

Scope requis : USERS_READ.

Seuls les comptes de pilotage de flotte (FLEET_ADMINISTRATOR, DAF) sont renvoyés. Les chauffeurs relèvent de GET /v1/papi/drivers.

Lister les comptes web d'une entreprise › path Parameters

companyId
​integer · min: 1 · required

Identifiant d'une entreprise de votre portefeuille.

Lister les comptes web d'une entreprise › Responses

Comptes de l'entreprise

​CompanyUser[]
GET/v1/papi/companies/{companyId}/users
curl https://instafuel-backend-staging.up.railway.app/v1/papi/companies/:companyId/users \ --header 'Authorization: Bearer <token>'
Example Responses
{ "data": [ { "id": 981, "ref": "USR-2C77A10B", "name": "Aminata Traoré", "email": "email", "phoneNumber": "phoneNumber", "role": "FLEET_ADMINISTRATOR", "companyId": 0, "status": "ACTIVE", "createdAt": "2024-08-25T15:00:00Z" } ] }
json
application/json

Créer un compte web chez une entreprise cliente

POST
https://instafuel-backend-staging.up.railway.app
/v1/papi/companies/{companyId}/users

Scope requis : USERS_WRITE.

Le compte reçoit un courriel d'activation contenant un lien à usage unique, valable 72 h. Aucun mot de passe ne transite par l'API.

Les coordonnées doivent être celles de l'entreprise cliente. Un email ou un téléphone appartenant à un compte apporteur est refusé en 422 RESELLER_SELF_ASSIGNMENT : un compte client donne accès à la surface de gestion de flotte de cette entreprise, qui n'est pas votre périmètre.

Créer un compte web chez une entreprise cliente › path Parameters

companyId
​integer · min: 1 · required

Identifiant d'une entreprise de votre portefeuille.

Créer un compte web chez une entreprise cliente › Headers

X-Idempotency-Key
​string · maxLength: 200 · required

Valeur unique par opération — un UUID convient. Rejouée à l'identique dans les 24 h, la requête renvoie la première réponse au lieu de créer un doublon.

Créer un compte web chez une entreprise cliente › Request Body

CompanyUserCreateRequest
name
​string · maxLength: 150 · required
email
​string · email · required

Sert à l'authentification et reçoit le lien d'activation.

phoneNumber
​string · maxLength: 30 · required
role
​string · enum · required
Enum values:
FLEET_ADMINISTRATOR
DAF
language
​string · enum
Enum values:
FR
EN

Créer un compte web chez une entreprise cliente › Responses

Compte créé, courriel d'activation envoyé

​CompanyUser
POST/v1/papi/companies/{companyId}/users
curl https://instafuel-backend-staging.up.railway.app/v1/papi/companies/:companyId/users \ --request POST \ --header 'Content-Type: application/json' \ --header 'X-Idempotency-Key: <string>' \ --header 'Authorization: Bearer <token>' \ --data '{ "name": "Aminata Traoré", "email": "a.traore@kouassi.ci", "phoneNumber": "+2250700000123", "role": "DAF" }'
Example Request Body
{ "name": "Aminata Traoré", "email": "a.traore@kouassi.ci", "phoneNumber": "+2250700000123", "role": "DAF" }
json
application/json
Example Responses
{ "data": { "id": 981, "ref": "USR-2C77A10B", "name": "Aminata Traoré", "email": "email", "phoneNumber": "phoneNumber", "role": "FLEET_ADMINISTRATOR", "companyId": 0, "status": "ACTIVE", "createdAt": "2024-08-25T15:00:00Z" } }
json
application/json

Mettre à jour un compte web

PATCH
https://instafuel-backend-staging.up.railway.app
/v1/papi/companies/{companyId}/users/{userId}

Scope requis : USERS_WRITE.

Mettre à jour un compte web › path Parameters

companyId
​integer · min: 1 · required

Identifiant d'une entreprise de votre portefeuille.

userId
​integer · min: 1 · required

Mettre à jour un compte web › Headers

X-Idempotency-Key
​string · maxLength: 200 · required

Valeur unique par opération — un UUID convient. Rejouée à l'identique dans les 24 h, la requête renvoie la première réponse au lieu de créer un doublon.

Mettre à jour un compte web › Request Body

CompanyUserUpdateRequest
name
​string
email
​string · email
phoneNumber
​string
role
​string · enum
Enum values:
FLEET_ADMINISTRATOR
DAF
status
​string · enum
Enum values:
ACTIVE
INACTIVE
SUSPENDED

Mettre à jour un compte web › Responses

Compte mis à jour

​CompanyUser
PATCH/v1/papi/companies/{companyId}/users/{userId}
curl https://instafuel-backend-staging.up.railway.app/v1/papi/companies/:companyId/users/:userId \ --request PATCH \ --header 'Content-Type: application/json' \ --header 'X-Idempotency-Key: <string>' \ --header 'Authorization: Bearer <token>' \ --data '{ "status": "INACTIVE" }'
Example Request Body
{ "status": "INACTIVE" }
json
application/json
Example Responses
{ "data": { "id": 981, "ref": "USR-2C77A10B", "name": "Aminata Traoré", "email": "email", "phoneNumber": "phoneNumber", "role": "FLEET_ADMINISTRATOR", "companyId": 0, "status": "ACTIVE", "createdAt": "2024-08-25T15:00:00Z" } }
json
application/json

EntreprisesWallet