Erreur interne du portail des développeurs

Vous consultez la documentation d'Apigee Edge.
Consultez la documentation Apigee X.
en savoir plus

Problème constaté

Une erreur s'est produite lors de l'exécution d'une requête API active à l'aide de SmartDocs depuis le portail des développeurs.

Messages d'erreur

Sur le portail des développeurs, l'erreur la plus fréquente est "Une erreur interne s'est produite. Veuillez réessayer."

Causes possibles :

Cette erreur peut se produire lorsque le portail des développeurs ne parvient pas à obtenir de réponse du backend (proxy smartdocs ou point de terminaison réel).

Diagnostic

Activez les outils pour les développeurs dans votre navigateur, puis consultez l'onglet "Network" (Réseau) pour identifier l'erreur réelle.

Les erreurs courantes et leurs causes typiques sont listées dans le tableau suivant:

Error

Cause(s) typique(s)

ERR_NAME_NOT_RESOLVED

Proxy SmartDocs mal configuré ou restrictions du pare-feu du réseau

Contenu mixte

Portail configuré sur HTTPS, requêtes SmartDocs via HTTP

500 – Erreur interne du serveur

Examinons chacune de ces causes une par une et les étapes pour résoudre le problème.

Proxy SmartDocs mal configuré ou restrictions du pare-feu du réseau

Le message "ERR_NAME_NOT_RESOLVED" indique que l'URL du proxy smartdocs est mal configurée ou que le réseau à partir duquel le portail est accessible ne peut pas appeler l'URL du proxy smartdocs en raison des restrictions du pare-feu. Le proxy smartdocs doit être accessible depuis Internet ou le réseau interne (pour les API internes).

Résolution

Assurez-vous que le proxy smartdocs est accessible depuis tous les réseaux requis en déployant le proxy smartdocs sur un hôte virtuel sur Edge avec un nom d'hôte accessible depuis Internet.

Portail configuré via HTTPS, requêtes SmartDocs via HTTP

L'erreur Contenu mixte indique que le proxy smartdocs est appelé via HTTP à partir d'une page chargée via HTTPS.

Résolution

Pour résoudre le problème, exposez le proxy Smartdocs via HTTPS. Pour ce faire, déployez le proxy smartdocs pour inclure un hôte virtuel configuré pour utiliser TLS/SSL (généralement l'hôte virtuel "sécurisé").

Proxy SmartDocs renvoyant une exception

Le message 500 – Erreur interne du serveur peut être dû à un problème avec le proxy "smartdocs". Dans ce cas, vous constatez que le proxy smartdocs renvoie cette erreur.

Diagnostic

Utilisez l'outil de traçage pour diagnostiquer les erreurs avec le proxy "smartdocs", comme décrit ci-dessous. Pour en savoir plus, consultez Utiliser l'outil Trace.

  1. Activez la trace pour le proxy "smartdocs" dans l'organisation "VALIDATE" afin de localiser la règle spécifique qui renvoie l'erreur interne du serveur 500.

  1. Sélectionnez la règle spécifique dans la trace pour identifier la cause de l'erreur.

Résolution

Corrigez l'erreur identifiée. Si vous avez besoin d'aide, contactez l'assistance Apigee Edge.

Les processeurs de messages Edge ne peuvent pas appeler le point de terminaison de l'API publié

500 – Une erreur interne du serveur peut également se produire lorsque les processeurs de messages appartenant à l'organisation hébergeant le proxy Smartdocs ne parviennent pas à appeler le point de terminaison de l'API.

Diagnostic

Utilisez l'outil de traçage pour diagnostiquer les erreurs avec le proxy "smartdocs", comme décrit ci-dessous. Pour en savoir plus, consultez Utiliser l'outil Trace.

  1. Activez trace pour le proxy "smartdocs" dans l'organisation "VALIDATE" afin de localiser la règle spécifique qui renvoie l'erreur interne du serveur 500.

  1. Dans l'exemple de trace d'interface utilisateur présenté ci-dessus, la règle JavaScript "BuildTargetAPIRequest" ne parvient pas à exécuter l'URL cible.
  1. Obtenez l'URL cible à partir de la règle JavaScript "BuildTargetAPIRequest".
  1. Appelez directement l'URL à partir des nœuds de traitement des messages associés à l'organisation "VALIDATE", comme indiqué ci-dessous :
    curl -v <target URL>
    
  1. Corrigez toute erreur observée.

Résolution

  1. Assurez-vous que les API publiées sur le portail des développeurs peuvent être appelées depuis les processeurs de messages associés à l'organisation "VALIDATE" et corrigez les erreurs rencontrées.
  1. Si vous pouvez exécuter l'appel d'API directement à partir du processeur de messages, il est très probable que vous puissiez également exécuter l'API via SmartDocs.
  1. Exécutez l'appel d'API via SmartDocs et vérifiez si le problème est résolu.