Gérer le profil de l'organisation

Vous consultez la documentation d'Apigee Edge.
Accédez à la documentation sur Apigee X. info

Les sections suivantes présentent le profil de l'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 d'Apigee Edge configure votre profil d'organisation.

Vous devez modifier le profil de votre organisation pour ajouter ou mettre à jour des informations la concernant, le cas échéant. Par exemple, vous devrez peut-être modifier le type de facturation, les paramètres de devise ou le modèle de taxes.

Configurez les informations de base sur votre organisation, y compris les éléments suivants:

• Nom, adresse et pays d'activité de l'organisation
• Type de facturation (prépaiement, postpaiement ou les deux), comme décrit dans la section Comprendre le type de facturation
• Cycle de facturation (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.

Modifier le profil de l'organisation à l'aide de l'UI

Pour modifier le profil de l'organisation à l'aide de l'interface utilisateur:

1. Accédez à la page Profil de l'organisation.
2. Cliquez sur Modifier.
3. Sous Nom et informations, modifiez le nom de l'organisation et le pays dans lequel elle exerce ses activités.
4. Sous Taxes et devise, modifiez les champs suivants:

   Champ	Description
   Modèle fiscal	Remarque:Ne s'applique que si vous configurez des plans tarifaires avec 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 : Révélée: le fournisseur d'API agit en tant que mandataire déclaré du développeur. Les revenus bruts (y compris les taxes de vente) collectés auprès de l'utilisateur final sont transmis au développeur. La commission du fournisseur d'API est collectée 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 perçue auprès de l'utilisateur final. C'est au développeur de déclarer la taxe de vente. Non divulgué: le fournisseur d'API agit en tant que mandataire non déclaré du développeur. Il déduit la taxe perçue auprès des utilisateurs finaux et la reverse aux autorités fiscales locales. Le développeur facture au fournisseur d'API la part des revenus nets qui lui est due (moins les taxes de vente et la commission du fournisseur d'API). Hybride: le fournisseur d'API agit en tant que mandataire déclaré du développeur. Toutefois, le fournisseur d'API paie la taxe de vente perçue auprès de ses clients aux autorités fiscales locales au nom du développeur. Le fournisseur d'API transfère les revenus restants au développeur, puis facture les frais de commission.
   Devise	devises acceptées par votre organisation. Pour les forfaits de partage des revenus, de tableau des tarifs et de frais uniquement, la devise par défaut est utilisée pour votre forfait. Lorsque vous créez une fiche tarifaire ou un forfait de frais uniquement, vous pouvez modifier la devise à utiliser en sélectionnant l'une des devises acceptées dans la liste. Vous pouvez éventuellement définir le montant minimal de recharge que les développeurs d'applications peuvent ajouter au solde de leur compte prépayé pour chaque devise. Pour ajouter une devise: Cliquez sur Ajouter une devise. Sélectionnez une devise dans le menu déroulant du champ Devise. Si vous le souhaitez, définissez le montant minimal que les développeurs d'applications peuvent ajouter au solde de leur compte prépayé dans la devise spécifiée dans le champ Recharge minimale. Cliquez sur Ajouter. Définissez-la comme devise par défaut, si vous le souhaitez, en cliquant sur la case d'option associée. Répétez ces étapes pour ajouter d'autres devises. Pour supprimer une devise, placez le curseur sur la devise que vous souhaitez supprimer, puis cliquez sur .

5. Gérez les conditions d'utilisation, comme décrit dans la section Gérer les conditions d'utilisation à l'aide de l'UI.
6. 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 la section Propriétés de configuration du profil de l'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 non seulement les propriétés 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 compatible que vous souhaitez définir par défaut.

Par exemple, l'appel d'API suivant met à jour currency sur USD et le paramètre du modèle de taxe sur 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 de l'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 postpayée à l'aide de l'API

Les comptes de développeur peuvent être configurés pour utiliser les types de facturation suivants: prépaiement, postpaiement 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 du solde prépayé du développeur, géré par un fournisseur de paiement intégré. Le développeur doit conserver une réserve prépayée suffisante pour acheter les API.

Avec les comptes postpayé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 conformément aux conditions de paiement définies par le ou les forfaits inclus sur la facture.

Pour configurer les types de facturation prépayés et postpayés de votre organisation, définissez la propriété supportedBillingType sur l'une des valeurs suivantes pour indiquer les types de facturation valides: PREPAID, POSTPAID ou BOTH. Si vous définissez la valeur sur BOTH, la valeur par défaut sera PREPAID lorsque vous ajouterez un développeur ou une entreprise d'applications. Dans ce cas, vous pouvez définir explicitement le type de facturation d'une entreprise ou d'un développeur d'application à l'aide de l'API, comme décrit dans la section Gérer les entreprises et les 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 d'utilisation d'un produit d'API au cours d'un mois calendaire.
• CALENDAR_MONTH: la facturation est mensuelle.

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 du profil d'organisation pour l'API

Le profil de l'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	Adresse de l'organisation, qui peut inclure l'adresse, la ville, l'État, le code postal, le pays et une indication si cette adresse est l'adresse principale de l'organisation.	N/A	Non
approveTrusted	Cette option n'est pas utilisée.	N/A	Non
approveUntrusted	Cette option n'est pas utilisée.	N/A	Non
billingCycle	Période du cycle de facturation. Les valeurs possibles sont les suivantes : AU PRORATA: la facturation est basée sur le nombre de jours d'utilisation d'un produit d'API dans un mois calendaire. CALENDAR_MONTH: la facturation est mensuelle. Consultez Configurer le cycle de facturation à l'aide de l'API.	N/A	Oui
country	Code ISO 3166-2 du 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 forfaits (modèle de facturation) : les mêmes règles s'appliquent que pour les forfaits de partage des revenus. Toutefois, vous pouvez définir la devise sur n'importe quelle devise acceptée par l'organisation. Pour les forfaits "Frais uniquement" : vous pouvez définir la devise sur n'importe quelle devise acceptée par l'organisation.	N/A	Oui
description	Brève description de l'organisation.	N/A	Non
hasBillingAdjustment	Indicateur indiquant 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 API pour vos produits d'API. La valeur peut être l'une des suivantes: "true" : les ajustements sont activés. "false" : les ajustements ne sont pas activés.	N/A	Non
hasBroker	Indicateur indiquant si les revenus sont basés sur le net. La valeur peut être l'une des suivantes: "true" : les revenus sont basés sur le montant net. false: les revenus ne sont pas basés sur le net.	N/A	Non
hasSelfBilling	Indicateur qui indique à la monétisation de générer une facture de facturation automatique au lieu d'une déclaration de partage des revenus. Une facture auto-facturée est un document financier qui détaille le montant dû au développeur de l'application. Il sert de facture au fournisseur d'API pour le compte du développeur d'applications. La valeur peut être l'une des suivantes: "true" : génère des factures d'autofacturation au lieu de relevés de partage des revenus. false: désactive l'autofacturation.	N/A	Non
hasSeparateInvoiceForProduct	Indicateur indiquant si une facture distincte est générée pour chaque produit d'API. La valeur peut être l'une des suivantes: "true" : une facture distincte est générée pour chaque produit d'API. false: Aucune facture distincte n'est générée pour chaque produit d'API.	N/A	Non
id	ID de l'organisation.	N/A	Non
issueNettingStmt	Indicateur indiquant si un relevé de compensation est généré lors de la création de documents de facturation. La valeur peut être l'une des suivantes: "true" : un relevé de compensation est généré lors de la création de documents de facturation. false: L'état de compensation n'est pas généré lors de la création de documents de facturation.	N/A	Non
logoUrl	URL du logo de l'organisation.	N/A	Non
name	Nom de l'organisation.	N/A	Oui
netPaymentAdviceNote	Note d'avis de paiement net.	N/A	Non
nettingStmtPerCurrency	Indicateur indiquant si un relevé de compensation distinct est généré pour chaque devise utilisée. La valeur peut être l'une des suivantes: "true" : un relevé de compensation distinct est généré pour chaque devise utilisée. false: aucun relevé de compensation distinct n'est généré pour chaque devise utilisée.	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 autofacturées sont activées, indique si elles le sont pour les organisations d'échange. La valeur peut être l'une des suivantes: "true" : les factures de facturation en libre-service sont activées pour les organisations de place de marché. false: les factures autofacturées ne sont pas activées pour les organisations d'échange.	N/A	Non
selfBillingForAllDev	Si les factures de facturation automatique sont activées, indique si elles le sont pour tous les développeurs d'applications. Par défaut, les factures de facturation automatique ne sont générées que pour les développeurs d'applications qui ont signé un contrat avec le fournisseur d'API. La valeur peut être l'une des suivantes: "true" : les factures d'autofacturation sont activées pour tous les développeurs d'applications. false: Les factures d'autofacturation ne sont pas activées pour tous les développeurs d'applications.	faux	Non
separateInvoiceForFees	Indicateur indiquant si une facture distincte est publiée pour les frais. La valeur peut être l'une des suivantes: "true" : une facture distincte est publiée pour les frais. false: aucune facture distincte n'est publiée pour les frais.	faux	Oui
status	État de l'organisation. Les valeurs valides sont les suivantes : ACTIF: le compte de l'organisation est enregistré pour la monétisation et peut être utilisé. INACTIVE: le compte de l'organisation est enregistré dans la monétisation, mais n'est pas disponible à l'utilisation.	N/A	Non
supportedBillingType	Modèle de paiement du développeur utilisé pour la facturation. Les valeurs possibles sont les suivantes : PREPAID: le développeur paie à l'avance l'utilisation d'un produit d'API. Les fonds sont déduits du solde du développeur lorsqu'il utilise le produit d'API. Le développeur doit conserver une réserve prépayée suffisante pour acheter le produit d'API. POSTPAID: le développeur est facturé chaque mois (via une facture) pour l'utilisation de produits d'API. Le développeur paie pour l'utilisation des produits d'API conformément aux conditions de paiement définies par le ou les forfaits inclus sur la facture. LES DEUX: compatible avec les deux types de facturation. La valeur par défaut est PREPAID. Consultez Configurer les types de facturation prépayée et postpayée à l'aide de l'API.	PREPAID	Oui
taxModel	Remarque:Ne s'applique que si vous configurez des plans tarifaires avec 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 : Révélée: le fournisseur d'API agit en tant que mandataire déclaré du développeur. Les revenus bruts (y compris les taxes de vente) collectés auprès de l'utilisateur final sont transmis au développeur. La commission du fournisseur d'API est collectée 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 perçue auprès de l'utilisateur final. C'est au développeur de déclarer la taxe de vente. Non divulgué: le fournisseur d'API agit en tant que mandataire non déclaré du développeur. Il déduit la taxe perçue auprès des utilisateurs finaux et la reverse aux autorités fiscales locales. Le développeur facture au fournisseur d'API la part des revenus nets qui lui est due (moins les taxes de vente et la commission du fournisseur d'API). Hybride: le fournisseur d'API agit en tant que mandataire déclaré du développeur. Toutefois, le fournisseur d'API paie la taxe de vente perçue auprès de ses clients aux autorités fiscales locales au nom du développeur. Le fournisseur d'API transfère les revenus restants au développeur, puis facture les frais de commission.	N/A	Oui
taxNexus	Pays dans lequel l'organisation est enregistrée à des fins fiscales.	N/A	Non
taxRegNo	Numéro d'enregistrement fiscal ou numéro d'enregistrement de la taxe sur la valeur ajoutée (TVA) de l'organisation, le cas échéant. Cette propriété est facultative, car le numéro d'enregistrement fiscal ou le numéro d'enregistrement TVA ne s'applique pas dans tous les pays. Le nombre 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 auquel les transactions peuvent être relayées, comme un entrepôt de données.	N/A	Non
timezone	Identifiant du fuseau horaire des 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 d'une entreprise ou d'un développeur d'applications

Forcez les paramètres du profil de monétisation d'une entreprise ou d'un développeur d'applications à l'aide de l'UI ou de l'API, comme décrit dans les sections suivantes:

• Gérer les attributs personnalisés d'un développeur d'applications
• Gérer les entreprises et les développeurs d'applications
• Gérer les développeurs d'applications