# Vue d'ensemble des API

One Platform expose l'Organizations API pour les partenaires et intégrateurs système qui doivent s'intégrer avec les capacités de plateforme limitées à une organisation.

L'API est documentée au moyen de la spécification OpenAPI liée ci-dessous.

| API | Fichier OpenAPI | Public |
|  --- | --- | --- |
| [Organizations API](/fr/products/oneplatform/one-platform-knowledge-center/04-api-and-integration/organizations-api/overview) | `apis/oas/organizations.json` | Partenaires et intégrateurs système agissant pour le compte d'une organisation One Platform. |


## Périmètre API

L'Organizations API est limitée à une organisation.

La plupart des endpoints suivent ce modèle de route :

```http
/v1/organizations/{id}/<resource>
```

Le paramètre de chemin `{id}` identifie le contexte d'organisation One Platform pour la requête. Le jeton d'accès utilisé par l'intégration doit être autorisé à opérer sur cette organisation.

## Capacités principales

L'API couvre actuellement les opérations limitées à une organisation pour :

| Domaine | Exemples |
|  --- | --- |
| Relations commerciales | Récupérer les relations commerciales et les chemins consommateurs associés. |
| Consumers | Récupérer les consommateurs connectés à une organisation et inspecter leurs détails. |
| Contrats | Créer, récupérer, mettre à jour et gérer les contrats d'organisation. |
| Éléments de contrat | Créer et gérer les lignes de service connectées à un contrat. |
| Activation de service | Récupérer les informations des groupes d'activation et exécuter des actions liées à l'activation. |
| Consommations | Récupérer les dernières consommations et les consommations agrégées pour des consommateurs ou relations commerciales. |
| Métriques produit | Récupérer les métriques produit pour les consommateurs liés à l'organisation. |


## Authentification

Les appels API utilisent des jetons Bearer émis par MyNamirial via OAuth2 Client Credentials.

Pour le flux d'authentification et les exemples de demande de jeton, consultez [Authentification](/fr/products/oneplatform/one-platform-knowledge-center/04-api-and-integration/authentication/authentication).

## URL de base

L'URL de base de l'API One Platform dépend de l'environnement cible et est fournie lors de la configuration de l'intégration.

Les exemples de cette documentation utilisent :

```shell
ONE_PLATFORM_BASE_URL="https://<one-platform-api-host>"
```

Utilisez la valeur fournie pour l'environnement avec lequel vous vous intégrez.

## Où aller ensuite

- [Authentification](/fr/products/oneplatform/one-platform-knowledge-center/04-api-and-integration/authentication/authentication) - OAuth2 Client Credentials avec MyNamirial.
- [Organizations API](/fr/products/oneplatform/one-platform-knowledge-center/04-api-and-integration/organizations-api/overview) - référence OpenAPI pour les intégrations partenaires.
- [Guides d'intégration](/fr/products/oneplatform/one-platform-knowledge-center/04-api-and-integration/integration-guides/integration-guides-overview) - exemples d'intégration orientés tâche.