Découvrir les API REST Oracle API Platform Cloud Service

Oracle API Platform Cloud Service fournit des services Web REST que vous pouvez utiliser pour automatiser certaines tâches.

Les API REST incluses dans Oracle API Platform Cloud Service sont les suivantes :

• Service d'administration : fournit des opérations permettant de gérer les artefacts de passerelle, de créer et d'obtenir des informations de stratégie, d'obtenir et de mettre à jour les préférences utilisateur, et d'obtenir des informations sur les rôles et les autorisations pour les utilisateurs, entre autres opérations d'administration.
• Analyse : fournit des opérations permettant d'obtenir des statistiques et des informations sur les performances telles que les applications actives, les échecs, le nombre total de demandes, les passerelles actives, les demandes et les réponses sous forme de données de séries temporelles, etc.
• Service client : fournit des opérations qui prennent en charge la création et la suppression d'applications, ou la mise à jour des informations d'application, l'ajout ou la suppression d'autorisations aux applications, la gestion des paramètres de configuration du portail de développeur, la définition ou la suppression de préférences utilisateur, etc.
• Contrôleur de passerelle : fournit les opérations liées à la configuration des noeuds et des profils de sécurité.
• Service de gestion : fournit des opérations permettant de créer et de déployer des API, des autorisations d'API, de créer et de gérer des applications, des déploiements et des habilitations d'API entre d'autres opérations.

The Management Service is a REST API that you can use to create and deploy APIs in Oracle API Platform Cloud Service.

Utiliser l'API de gestion Oracle API Platform Cloud Service pour créer une API

Utilisez l'API de gestion Oracle API Platform Cloud Service pour créer des API à l'aide de REST.

Pour créer une API à l'aide de l'API REST de gestion, vous pouvez utiliser cURL ou le client REST de votre préférence pour vérifier que vous disposez du rôle Gestionnaire d'API avant d'exécuter les commandes REST dans vos scripts.

1. Dans un éditeur, créez un modèle JSON de base pour la demande cURL avec les informations suivantes.

   {
       "name": "YOUR_API_NAME",
       "version": "YOUR_API_VERSION",
       "implementation":
       {
           "policies": [
           {
               "id": "1",
               "type": "o:ApiRequest",
               "version": "1.0",
               "draft": true,
               "config":
               {}
           },
           {
               "id": "2",
               "type": "o:ServiceRequest",
               "version": "1.0",
               "draft": true,
               "config":
               {}
           },
           {
               "id": "3",
               "type": "o:ServiceResponse",
               "version": "1.0",
               "config":
               {}
           },
           {
               "id": "4",
               "type": "o:ApiResponse",
               "version": "1.0",
               "config":
               {}
           }],
           "executions":
           {
               "request": ["1", "2"],
               "response": ["3", "4"]
           }
       }
   }

   Dans le modèle JSON, name est votre nom d'API et version est votre version d'API. Ce modèle contient les informations essentielles minimales requises pour créer une API dans Oracle API Platform Cloud Service, telles qu'un nom d'API, une version, les stratégies de demande d'API et de demande de service en mode brouillon, ainsi que les stratégies de réponse de service et de réponse d'API.

2. By using cURL or your REST client, make a POST request to the https://YOUR-API-PCS-INSTANCE-URL/apiplatform/management/v1/apis endpoint, where YOUR-API-PCS-INSTANCE-URL is the URL of your Oracle API Platform Cloud Service instance.
3. Vérifiez les en-têtes de réponse à partir de la demande et du corps de la réponse.

   HTTP/1.1 200 OK 
   Server: Oracle-Traffic-Director/12.2.1.0.0
   Date: Tue, 19 Jul 2016 13:27:08 GMT
   Content-Length: 30
   Content-Type: application/json
   X-oracle-dms-ecid: dd439614-7d4f-47ad-a1ea-a25a74ec9403-0000032d
   X-oracle-dms-rid: 0:1
   Via: 1.1 otd_opc
   Proxy-agent: Oracle-Traffic-Director/12.2.1.0.0

   Le corps de la réponse du serveur est également au format JSON.

   {
     "id": "101",
     "iterationId": "1"
   }