Vous consultez la documentation d'Apigee Edge.
Consultez la
documentation Apigee X. en savoir plus
Les sections suivantes présentent le profil d'organisation et expliquent comment le gérer à l'aide de l'interface utilisateur et de l'API.
À propos du profil de l'organisation
Lors de la configuration initiale de la monétisation, l'équipe de configuration Apigee Edge configure le profil de votre organisation.
Vous devez modifier le profil de l'organisation pour ajouter ou mettre à jour des informations sur votre organisation, le cas échéant. Par exemple, vous devrez peut-être mettre à jour le type de facturation, les paramètres de devise ou le modèle fiscal.
Configurez les informations de base sur votre organisation, y compris:
- Nom, adresse et pays d'activité de l'organisation
- Type de facturation (prépayée, postpayée ou les deux), comme décrit dans la section Comprendre les types de facturation
- Cycle de facturation (au prorata ou mois calendaire)
- Devise de base
- Modèle fiscal utilisé par votre organisation
Vous pouvez gérer le profil de votre organisation à l'aide de l'interface utilisateur et de l'API, comme décrit dans les sections suivantes.
Explorer la page "Profil de l'organisation"
Accédez à la page "Profil de l'organisation", comme décrit ci-dessous.
Périphérie
Pour accéder à la page Profil de l'organisation à l'aide de l'interface utilisateur Edge:
- Connectez-vous à apigee.com/edge.
- Sélectionnez Publier > Monétisation > Profil de l'organisation dans la barre de navigation de gauche.
La page "Profil de l'organisation" s'affiche.
Comme le montre la figure, la page "Profil de l'organisation" vous permet de:
- Afficher les paramètres actuels du profil de l'organisation
- Modifier les paramètres du profil de l'organisation, y compris :
- Nom et informations
- Taxes et devise
- les conditions d'utilisation, comme décrit dans la section Gérer les conditions d'utilisation ;
Classic Edge (cloud privé)
Pour accéder à la page Profil de l'organisation à l'aide de l'interface utilisateur Classic Edge:
- Connectez-vous à
http://ms-ip:9000
, où ms-ip correspond à l'adresse IP ou au nom DNS du nœud du serveur de gestion. - Sélectionnez Admin > Profil de l'organisation dans la barre de navigation supérieure.
La page "Profil de l'organisation" s'affiche.
La page "Profil de l'organisation" vous permet de:
- Afficher les paramètres actuels du profil de l'organisation
- Modifier les paramètres du profil de l'organisation, y compris :
- Nom et informations
- Taxes et devise
- les conditions d'utilisation, comme décrit dans la section Gérer les conditions d'utilisation ;
Modifier le profil de l'organisation à l'aide de l'interface utilisateur
Pour modifier le profil de l'organisation à l'aide de l'interface utilisateur:
- Accédez à la page Profil de l'organisation.
- Cliquez sur Modifier.
- Sous Nom et informations, modifiez le nom de l'organisation et le pays d'activité.
- Sous Taxes et devise, modifiez les champs suivants:
Champ Description Modèle fiscal Remarque:S'applique uniquement si vous configurez des plans tarifaires pour le partage des revenus et que vous souhaitez générer des documents de facturation.
Modèle fiscal pour les plans tarifaires de partage des revenus qui identifie le type de documents de facturation requis.
Les valeurs valides sont les suivantes :
- Divulgation: le fournisseur d'API agit en tant qu'agent divulgué du développeur. Le revenu brut (taxes de vente comprises) perçu auprès de l'utilisateur final est transmis au développeur. La commission du fournisseur d'API est perçue auprès du développeur sous la forme d'une facture de commission. Le fournisseur d'API ne gère pas la taxe de vente collectée auprès de l'utilisateur final. Il appartient au développeur de la déclarer.
- Non divulgué: le fournisseur d'API agit en tant qu'agent non divulgué du développeur, déduit la taxe collectée auprès des utilisateurs finaux et la rembourse aux autorités fiscales locales. Le développeur facture au fournisseur d'API la part de revenus nette qui lui est due (moins les taxes de vente et la commission du fournisseur d'API).
- Hybride: le fournisseur d'API agit en tant qu'agent divulgué du développeur. Toutefois, le fournisseur d'API paie aux autorités fiscales locales la taxe de vente collectée auprès de leurs abonnés pour le compte du développeur. Le fournisseur d'API transfère les revenus restants au développeur, puis facture les frais de commission.
Currency Devises acceptées par votre organisation. Pour les plans basés sur le partage des revenus, le tableau des tarifs et les frais uniquement, la devise par défaut est utilisée. Lorsque vous créez un tableau des tarifs ou un plan payant uniquement, vous pouvez modifier la devise à utiliser en la sélectionnant dans la liste des devises acceptées. Si vous le souhaitez, vous pouvez définir le montant minimal de recharge que les développeurs d'applications peuvent ajouter au solde prépayé de leur compte pour chaque devise.
Pour ajouter une devise:
- Cliquez sur Ajouter une devise.
- Sélectionnez une devise dans le menu déroulant du champ Devise.
- Vous pouvez également définir le montant minimal que les développeurs d'applications peuvent ajouter au solde prépayé de leur compte dans la devise spécifiée dans le champ Crédit minimal.
- Cliquez sur Add (Ajouter).
- Si vous le souhaitez, définissez-la comme devise par défaut en cliquant sur la case d'option correspondante.
- Répétez ces étapes pour ajouter d'autres devises.
Pour supprimer une devise, placez votre curseur sur la devise à supprimer, puis cliquez sur .
- Gérez les conditions d'utilisation comme décrit dans la section Gérer les conditions d'utilisation à l'aide de l'interface utilisateur.
- Cliquez sur Enregistrer.
Gérer le profil de l'organisation à l'aide de l'API
Gérez le profil de l'organisation à l'aide de l'API, comme décrit dans les sections suivantes.
Afficher le profil de l'organisation à l'aide de l'API
Affichez le profil de votre organisation en envoyant une requête GET à /mint/organizations/{org_name}
. Exemple :
curl -X GET "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}" \ -H "Accept: application/json" \ -u email:password
Voici un exemple de réponse : Pour en savoir plus sur les options affichées, consultez Propriétés de configuration du profil d'organisation pour l'API.
{ "address" : [ { "address1" : "Test address”, "city" : "Test City", "country" : "US", "id" : "test-address", "isPrimary" : true, "state" : "CA", "zip" : "54321" } ], "approveTrusted" : false, "approveUntrusted" : false, "billingCycle" : "CALENDAR_MONTH", "country" : "US", "currency" : "USD", "description" : "Test organization", "hasBillingAdjustment" : true, "hasBroker" : false, "hasSelfBilling" : false, "hasSeparateInvoiceForProduct" : false, "id" : "{org_name}" "issueNettingStmt" : false, "logoUrl" : " https://dl.dropboxusercontent.com/u/48279818/LOGOS/testorg.jpeg", "name" : "myorg", "nettingStmtPerCurrency" : false, "regNo" : "RegNo-1234-myorg", "selfBillingAsExchOrg" : false, "selfBillingForAllDev" : false, "separateInvoiceForFees" : true, "status" : "ACTIVE", "supportedBillingType" : "PREPAID", "taxModel" : "UNDISCLOSED", "taxRegNo" : "TaxRegNo-1234-myorg", "timezone" : "UTC" }
Modifier le profil de l'organisation à l'aide de l'API
Modifiez le profil de l'organisation en envoyant une requête PUT à /mint/organizations/{org_name}
. Lorsque vous modifiez le profil de l'organisation, vous devez spécifier toutes les propriétés du profil de l'organisation, et pas seulement celles que vous modifiez.
Pour modifier la devise par défaut de l'organisation, définissez la valeur currency
sur le code de devise ISO 4217 de la devise acceptée que vous souhaitez définir par défaut.
Par exemple, l'appel d'API suivant remplace currency
par USD et le paramètre de modèle fiscal par HYBRID
(les champs mis à jour sont mis en surbrillance dans l'exemple). Pour en savoir plus sur les options affichées, consultez la section Propriétés de configuration du profil d'organisation pour l'API.
curl -X PUT "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}" \ -H "Content-Type: application/json" \ -d '{ "address" : [ { "address1" : "Test address”, "city" : "Test City", "country" : "US", "id" : "corp-address", "isPrimary" : true, "state" : "CA", "zip" : "54321" } ], "approveTrusted" : false, "approveUntrusted" : false, "billingCycle" : "CALENDAR_MONTH", "country" : "US", "currency" : "USD", "description" : "Test organization", "hasBillingAdjustment" : true, "hasBroker" : false, "hasSelfBilling" : false, "hasSeparateInvoiceForProduct" : false, "id" : "myorg", "issueNettingStmt" : false, "logoUrl" : "https://dl.dropboxusercontent.com/u/48279818/LOGOS/testorg.jpeg", "name" : "{org_name}", "nettingStmtPerCurrency" : false, "regNo" : "RegNo-1234-myorg", "selfBillingAsExchOrg" : false, "selfBillingForAllDev" : false, "separateInvoiceForFees" : false, "status" : "ACTIVE", "supportedBillingType" : "POSTPAID", "taxModel" : "HYBRID", "taxRegNo" : "TaxRegNo-1234-myorg", "timezone" : "UTC" }' \ -u email:password
Configurer les types de facturation prépayée et post-payée à l'aide de l'API
Les comptes de développeur peuvent être configurés pour utiliser les types de facturation suivants: prépaiement, post-paiement ou les deux.
Avec les comptes prépayés, les développeurs paient à l'avance l'utilisation de vos API. Les fonds sont déduits de la réserve prépayée du développeur, qui est gérée par un fournisseur de services de paiement intégré. Le développeur doit disposer d'un solde prépayé suffisant pour acheter les API.
Avec les comptes post-payés, les développeurs sont facturés mensuellement (par le biais d'une facture) à la fin du mois. Le développeur paie pour l'utilisation des produits d'API en fonction des conditions de paiement définies par le ou les forfaits figurant sur la facture.
Pour configurer les types de facturation prépayée et post-payée pour votre organisation, définissez la propriété supportedBillingType
sur l'une des valeurs suivantes afin d'indiquer les types de facturation valides: PREPAID
, POSTPAID
ou BOTH
. Si vous définissez la valeur sur BOTH
, la valeur par défaut est PREPAID
lorsque vous ajoutez un développeur d'applications ou une entreprise. Dans ce cas, vous pouvez définir explicitement le type de facturation pour une entreprise ou un développeur d'applications à l'aide de l'API, comme décrit dans la section Gérer des entreprises et des développeurs d'applications.
Exemple :
curl -X PUT "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}" \ -H "Content-Type: application/json" \ -d '{ "address" : [ { "address1" : "Test address", "city" : "Test City", "country" : "US", "id" : "corp-address", "isPrimary" : true, "state" : "CA", "zip" : "54321" } ], "approveTrusted" : false, "approveUntrusted" : false, "billingCycle" : "CALENDAR_MONTH", "country" : "US", "currency" : "USD", "description" : "Test organization", "hasBillingAdjustment" : true, "hasBroker" : false, "hasSelfBilling" : false, "hasSeparateInvoiceForProduct" : false, "id" : "myorg", "issueNettingStmt" : false, "logoUrl" : "https://dl.dropboxusercontent.com/u/48279818/LOGOS/testorg.jpeg", "name" : "{org_name}", "nettingStmtPerCurrency" : false, "regNo" : "RegNo-1234-myorg", "selfBillingAsExchOrg" : false, "selfBillingForAllDev" : false, "separateInvoiceForFees" : false, "status" : "ACTIVE", "supportedBillingType" : "POSTPAID", "taxModel" : "HYBRID", "taxRegNo" : "TaxRegNo-1234-myorg", "timezone" : "UTC" }' \ -u email:password
Configurer le cycle de facturation à l'aide de l'API
Pour configurer le cycle de facturation de votre organisation, définissez la propriété billingCycle
sur l'une des valeurs suivantes:
PRORATED
: la facturation est basée sur le nombre de jours pendant lesquels un produit API est utilisé au cours d'un mois calendaire.CALENDAR_MONTH
: la facturation est effectuée mensuellement.
Exemple :
curl -X PUT "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}" \ -H "Content-Type: application/json" \ -d '{ "address" : [ { "address1" : "Test address", "city" : "Test City", "country" : "US", "id" : "corp-address", "isPrimary" : true, "state" : "CA", "zip" : "54321" } ], "approveTrusted" : false, "approveUntrusted" : false, "billingCycle" : "CALENDAR_MONTH", "country" : "US", "currency" : "USD", "description" : "Test organization", "hasBillingAdjustment" : true, "hasBroker" : false, "hasSelfBilling" : false, "hasSeparateInvoiceForProduct" : false, "id" : "myorg", "issueNettingStmt" : false, "logoUrl" : "https://dl.dropboxusercontent.com/u/48279818/LOGOS/testorg.jpeg", "name" : "{org_name}", "nettingStmtPerCurrency" : false, "regNo" : "RegNo-1234-myorg", "selfBillingAsExchOrg" : false, "selfBillingForAllDev" : false, "separateInvoiceForFees" : false, "status" : "ACTIVE", "supportedBillingType" : "POSTPAID", "taxModel" : "HYBRID", "taxRegNo" : "TaxRegNo-1234-myorg", "timezone" : "UTC" }' \ -u email:password
Propriétés de configuration d'un profil d'organisation pour l'API
Le profil d'organisation vous permet de définir les propriétés de configuration suivantes à l'aide de l'API.
Nom | Description | Par défaut | Obligatoire ? |
---|---|---|---|
address |
L'adresse de l'organisation, qui peut inclure l'adresse postale, la ville, l'État, le code postal et le pays, ainsi qu'une indication s'il s'agit de l'adresse principale de l'organisation. |
N/A | Non |
approveTrusted |
Cet indicateur n'est pas utilisé. |
N/A | Non |
approveUntrusted |
Cet indicateur n'est pas utilisé. |
N/A | Non |
billingCycle |
Période du cycle de facturation. Les valeurs possibles sont les suivantes :
Pour en savoir plus, consultez Configurer le cycle de facturation à l'aide de l'API. |
N/A | Oui |
country |
Code ISO 3166-2 pour le pays d'activité de l'organisation (par exemple, BR pour le Brésil). |
N/A | Oui |
currency |
Code ISO 4217 de la devise "de base" ou comptable utilisée par l'organisation (par exemple, USD pour le dollar américain). Pour les plans de partage des revenus: la devise spécifiée est utilisée pour votre plan. Pour les plans basés sur un tableau des tarifs (modèle de facturation) : il en va de même pour les plans de partage des revenus. Toutefois, vous pouvez remplacer le paramètre de devise par n'importe quelle devise acceptée par l'organisation. Pour les forfaits avec frais uniquement: vous pouvez remplacer le paramètre de devise par n'importe quelle devise acceptée par l'organisation. |
N/A | Oui |
description |
Brève description de l'organisation. |
N/A | Non |
hasBillingAdjustment |
Indicateur spécifiant si les ajustements sont activés. Si cette option est activée, vous pouvez ajuster les détails du trafic enregistrés par les services d'API pour vos produits d'API. La valeur peut être l'une des suivantes:
|
N/A | Non |
hasBroker |
Indicateur spécifiant si les revenus sont basés sur des valeurs nettes. La valeur peut être l'une des suivantes:
|
N/A | Non |
hasSelfBilling |
Option indiquant à la monétisation de générer une facture avec auto-facturation au lieu d'un relevé de part des revenus. Une facture d'auto-facturation est un document financier qui détaille le montant dû au développeur de l'application. Il s'agit d'une facture adressée au fournisseur d'API au nom du développeur de l'application. La valeur peut être l'une des suivantes:
|
N/A | Non |
hasSeparateInvoiceForProduct |
Indicateur spécifiant si une facture distincte est générée pour chaque produit d'API. La valeur peut être l'une des suivantes:
|
N/A | Non |
id |
ID de l'organisation. |
N/A | Non |
issueNettingStmt |
Indicateur spécifiant si un état de compensation est généré lors de la création des documents de facturation. La valeur peut être l'une des suivantes:
|
N/A | Non |
logoUrl |
URL du logo de l'entreprise. |
N/A | Non |
name |
Nom de l'organisation. |
N/A | Oui |
netPaymentAdviceNote |
Remarque concernant l'avis de paiement net. |
N/A | Non |
nettingStmtPerCurrency |
Indicateur spécifiant si une instruction de mailing distincte est générée pour chaque devise utilisée. La valeur peut être l'une des suivantes:
|
N/A | Non |
regNo |
Numéro d'enregistrement de l'organisation. Le numéro que vous saisissez pour cette propriété s'affiche au bas des documents de facturation. |
N/A | Non |
selfBillingAsExchOrg |
Si les factures d'auto-facturation sont activées, indique si elles sont activées pour les organisations de places de marché. La valeur peut être l'une des suivantes:
|
N/A | Non |
selfBillingForAllDev |
Si les factures d'auto-facturation sont activées, indique si elles sont activées pour tous les développeurs d'applications. Par défaut, les factures d'auto-facturation ne sont générées que pour les développeurs d'applications qui ont signé un accord avec le fournisseur d'API. La valeur peut être l'une des suivantes:
|
false | Non |
separateInvoiceForFees |
Option indiquant si une facture distincte est publiée pour les frais. La valeur peut être l'une des suivantes:
|
false | Oui |
status |
État de l'organisation. Les valeurs valides sont les suivantes :
|
N/A | Non |
supportedBillingType |
Modèle de paiement du développeur utilisé pour la facturation. Les valeurs possibles sont les suivantes :
Consultez la section Configurer des types de facturation prépayée et post-payée à l'aide de l'API. |
PRÉPAYÉ | Oui |
taxModel |
Remarque:S'applique uniquement si vous configurez des plans tarifaires pour le partage des revenus et que vous souhaitez générer des documents de facturation. Modèle fiscal pour les plans tarifaires de partage des revenus qui identifie le type de documents de facturation requis. Les valeurs valides sont les suivantes :
|
N/A | Oui |
taxNexus |
Pays dans lequel l'organisation est enregistrée pour des raisons fiscales. |
N/A | Non |
taxRegNo |
Numéro d'identification fiscale ou numéro de TVA de l'organisation, le cas échéant. Cette propriété est facultative, car le numéro d'identification fiscale ou de TVA ne s'applique pas dans tous les pays. Le numéro que vous saisissez pour ce paramètre s'affiche au bas des documents de facturation. |
N/A | Non |
transactionRelayURL |
URL d'un autre système vers lequel les transactions peuvent être relayées, comme un entrepôt de données. |
N/A | Non |
timezone |
Identifiant de fuseau horaire pour les opérations de l'organisation, par exemple Amérique/New_York ou Europe/Paris. Les abréviations de fuseau horaire, telles que UTC, EST (heure normale de l'Est) ou CET (heure d'Europe centrale), sont également acceptées. |
N/A | Oui |
Remplacer les paramètres du profil de monétisation pour une entreprise ou un développeur d'applications
Remplacez les paramètres du profil de monétisation pour une entreprise ou un développeur d'applications à l'aide de l'interface utilisateur ou de l'API, comme décrit dans les sections suivantes: