Aide du Hub TheSocle · apim.apinew.creer

Créer l'API

Enregistre l'API dans le catalogue, recharge la passerelle et ouvre la fiche de l'API.

Voir l'élément dans l'écran : hub/apim/apis-new

Explication

Le Hub insère l'API et recharge aussitôt son catalogue : une API créée en published est servie tout de suite. Un message « API créée (#id) » s'affiche, puis la fiche s'ouvre après une seconde et demie. En cas de refus (slug déjà pris, champ manquant), le message d'erreur s'affiche en rouge sous le bouton et rien n'est créé.

Fiche complète

Requête

POST /api/apim/admin/apis (JSON). Les champs vides ne sont pas envoyés ; les montants et le port partent en nombres.

Paramètre Obligatoire Défaut
slug, display_name oui (navigateur)
public_hostname, base_path_external, target_backend_type oui (navigateur)
required_scope oui (navigateur)
description, owner_app_id, target_app_id, target_port, target_url, target_path_internal non
scan_guard_enabled non true
cost_per_call_cents, cost_per_mb_in_cents, cost_per_mb_out_cents non 0
status non draft
default_rate_per_second / _minute / _day non (pas à l'écran) aucun plafond

Réponses

201 { "status": "created", "x_id": 12 } ; 400 { "error": "…" } avec le message de la base.

Pièges

Sommaire du démonstrateur