---
title: "API"
weight: 80
description: "API DoliProxy : jetons personnels pour piloter vos proxies et consulter votre facturation, et jetons d'instance pour vos applications hébergées."
---

# API

DoliProxy expose une API REST. La documentation interactive complète est accessible à l'adresse `/docs/api`.

On distingue deux familles d'authentification :

- **API utilisateur** -- vos jetons personnels, pour piloter vos proxies et consulter votre facturation
- **API à jeton d'instance / de proxy** -- jetons dédiés, pour vos applications hébergées qui remontent leurs métriques

## API utilisateur

### Vos jetons et permissions

Vous créez vos jetons d'API depuis **Mon profil**, dans le panneau. Chaque jeton porte des permissions que vous choisissez :

| Permission | Usage |
|------------|-------|
| `proxy:read` | Lecture de vos proxies et de leurs blocages |
| `proxy:write` | Modification des réglages et gestion des IP bloquées |
| `billing:read` | Lecture de vos métriques de facturation |

Les routes utilisateur exigent un abonnement actif ou un essai en cours, et sont limitées à 60 requêtes par minute.

### Gestion des proxies

Sous le préfixe `/api/v1/proxies` :

| Méthode | Route | Rôle |
|---------|-------|------|
| GET | `/` | Liste de vos proxies |
| GET | `/{proxy}` | Détail d'un proxy |
| PATCH | `/{proxy}/geo-restriction` | Restriction géographique |
| PATCH | `/{proxy}/rate-limit` | Limitation de débit |
| PATCH | `/{proxy}/conn-limit` | Limitation de connexions |
| PATCH | `/{proxy}/bot-filtering` | Filtrage de bots |
| PATCH | `/{proxy}/auto-block` | Blocage automatique d'IP |
| PATCH | `/{proxy}/maintenance` | Mode maintenance |
| GET | `/{proxy}/blocked-ips` | Liste des IP bloquées |
| POST | `/{proxy}/blocked-ips` | Bloquer une IP |
| DELETE | `/{proxy}/blocked-ips/{blockedIp}` | Débloquer une IP |

### Facturation

Sous le préfixe `/api/v1/billing` :

| Méthode | Route | Rôle |
|---------|-------|------|
| GET | `/usage` | Votre consommation courante |
| GET | `/subscription` | Détail de votre abonnement |
| GET | `/plans` | Plans disponibles |

## API instance PWA

Vos instances PWA hébergées s'authentifient avec un jeton bearer dédié.

### Routes publiques (sans jeton)

Sous `/api/v1/instance`, limitées à 10 requêtes par minute :

| Méthode | Route | Rôle |
|---------|-------|------|
| POST | `/proposals` | Propositions d'instances pour un email |
| POST | `/token` | Délivrance initiale du jeton (email, code module, URL Dolibarr) |
| POST | `/token/recover` | Envoi d'un code de récupération par email (2FA) |
| POST | `/token/recover/confirm` | Confirmation du code et nouveau jeton |

### Routes protégées (jeton bearer)

| Méthode | Route | Rôle |
|---------|-------|------|
| POST | `/check` | Statut de l'instance (active / suspendue) |
| POST | `/usage` | Remontée de métriques d'usage |
| POST | `/deprovision` | Désactivation volontaire |
| GET | `/settings` | Lecture des réglages de l'instance |
| PATCH | `/settings` | Mise à jour des réglages |

## API proxy classique

Pour les proxies en mode `proxy` provisionnés via l'API, sous `/api/v1/proxy` :

### Enregistrement public (sans jeton)

| Méthode | Route | Rôle |
|---------|-------|------|
| POST | `/slug/check` | Vérifie la disponibilité d'un identifiant |
| POST | `/onboard` | Démarre l'enregistrement |
| POST | `/onboard/confirm` | Confirme l'enregistrement |
| POST | `/onboard/resend` | Renvoie le code de confirmation |
| POST | `/recover` | Récupération d'accès |
| POST | `/recover/confirm` | Confirmation de la récupération |

### Routes protégées (jeton bearer)

| Méthode | Route | Rôle |
|---------|-------|------|
| POST | `/check` | Statut du proxy |
| PATCH | `/` | Mise à jour du proxy |
| DELETE | `/` | Suppression du proxy |

> **Sécurité** : les jetons d'instance et de proxy sont stockés hachés (SHA256) et délivrés une seule fois. En cas de perte, utilisez la procédure de récupération par code envoyé par email.