Gérer le profil de l'organisation

<ph type="x-smartling-placeholder"></ph> Vous consultez la documentation Apigee Edge.
Accédez à la page Documentation sur Apigee X. En savoir plus

Les sections suivantes présentent le profil d'organisation et expliquent comment le gérer à l'aide de l'UI et de l'API.

À propos du profil de l'organisation

Dans le cadre de la configuration initiale de la monétisation, l'équipe de configuration d'Apigee Edge définit le profil de votre organisation.

Vous devez modifier le profil de votre organisation pour ajouter ou mettre à jour des informations sur votre organisation, 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 taxe.

Configurez les informations de base sur votre organisation, y compris:

  • Nom, adresse et pays d'activité de l'organisation
  • le type de facturation (prépayée, post-payée ou les deux), comme indiqué dans l'article Comprendre le type 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'UI et de l'API, comme décrit dans la section dans les sections suivantes.

Explorer la page "Profil de l'organisation"

Accédez à la page "Profil de l'organisation", comme décrit ci-dessous.

Edge

Pour accéder à la page "Profil de l'organisation" à l'aide de l'interface utilisateur Edge:

  1. Connectez-vous à apigee.com/edge.
  2. 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
  • Modifiez les paramètres du profil de l'organisation, y compris les suivants: <ph type="x-smartling-placeholder">

Classic Edge (cloud privé)

Pour accéder à la page "Profil de l'organisation" à l'aide de l'interface utilisateur Edge classique:

  1. Connectez-vous à http://ms-ip:9000, où ms-ip est le Adresse IP ou nom DNS du nœud du serveur de gestion.
  2. 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
  • Modifiez les paramètres du profil de l'organisation, y compris les suivants: <ph type="x-smartling-placeholder">

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 et le pays d'activité de l'organisation.
  4. 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 pour 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 :

    • Divulgée: le fournisseur d'API agit en tant qu'agent déclaré de développeur. Le revenu brut (y compris les taxes de vente) perçu auprès de l'utilisateur final est transmis au développeur. La commission du fournisseur d'API est collectée sur la développeur sous forme de facture de commission. Le fournisseur d'API ne gère pas taxe de vente perçue auprès de l'utilisateur final, sous la responsabilité du développeur pour déclarer la taxe de vente.
    • Non divulgué: le fournisseur d'API agit en tant qu'agent non divulgué de le développeur, déduit la taxe collectée auprès des utilisateurs finaux et la verse au des autorités fiscales locales. Le développeur facture les revenus nets au fournisseur d'API. de la part due au développeur (les taxes sur les ventes en moins et les dépenses commission.
    • Mixte: le fournisseur d'API agit en tant qu'agent développeur. Cependant, le fournisseur d'API paie la taxe de vente collectée abonnés à l'administration fiscale locale pour le compte du développeur. L'API transmet les revenus restants au développeur, puis facture les des frais de commission.
    Devise

    Devises acceptées par votre organisation. Pour le partage des revenus, le tableau des tarifs et les plans avec frais uniquement, la devise par défaut est utilisée pour votre plan tarifaire. Lorsque vous créez un tableau des tarifs ou un plan de frais uniquement, vous pouvez changer la devise utiliser en sélectionnant une devise prise en charge dans la liste. Si vous le souhaitez, vous pouvez définir le montant de crédit minimal que les développeurs d'applications peuvent ajouter à la réserve prépayée de leur compte pour chaque devise.

    Pour ajouter une devise:

    1. Cliquez sur Ajouter une devise.
    2. Sélectionnez une devise dans le menu déroulant du champ Devise.
    3. Si vous le souhaitez, définissez le montant minimal que les développeurs d'applications peuvent ajouter à la réserve prépayée de leur compte dans la devise spécifiée dans le champ Crédit minimal.
    4. Cliquez sur Ajouter.
    5. Définissez la devise par défaut, si vous le souhaitez, en cliquant sur la case d'option associée.
    6. Répétez cette procédure pour ajouter d'autres devises.

    Pour supprimer une devise, placez le curseur dessus, puis cliquez sur .
  5. Gérez les conditions d'utilisation, comme indiqué dans la section Gérer les conditions d'utilisation à l'aide de l'interface utilisateur.
  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 demande 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 consultez la section 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 tous les du profil de votre organisation, et pas seulement celles que vous modifiez.

Pour modifier la devise par défaut de l'organisation, définissez la valeur currency sur la devise ISO 4217 ; de la devise acceptée que vous souhaitez définir comme la devise par défaut.

Par exemple, l'appel d'API suivant met à jour currency en USD ainsi que le modèle fiscal. défini sur HYBRID (les champs mis à jour sont mis en surbrillance dans l'exemple). Pour plus sur les options affichées, consultez la section Configuration du profil d'organisation de 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é et post-payé à l'aide de l'API

Les comptes de développeur peuvent être configurés pour utiliser les types de facturation suivants: prépayé, post-payé ou les deux.

Avec les comptes prépayés, les développeurs paient à l'avance pour l'utilisation de vos API. Les fonds sont déduits du solde prépayé du développeur géré par un fournisseur de services de paiement intégré. Le développeur doit disposer d'une réserve prépayée suffisante pour acheter les API.

Avec les comptes au post-paiement, les développeurs sont facturés mensuellement (via une facture) à la fin du mois. Le développeur paie pour l'utilisation des produits d'API selon les conditions de paiement définies par le ou les forfaits inclus sur la facture.

Pour configurer des types de facturation prépayé et post-payé pour votre organisation, définissez la propriété supportedBillingType sur l'une des les 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 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 Gestion d'entreprises et de 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 API 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 du 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

Adresse de l'organisation, qui peut inclure l'adresse postale, la ville, l'État et le code postal le code pays, le pays et une indication s'il s'agit de l'adresse principale de l'adresse 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 :

  • AU PRORATÉ: la facturation est basée sur le nombre de jours d'utilisation d'un produit API au cours d'une mois civil.
  • AGE_MONTH: la facturation est effectuée mensuellement.

Consultez Configurer le cycle de facturation à l'aide de l'API.

N/A Oui
country

Code ISO 3166-2 du pays pour l'organisation, comme le Brésil pour le Brésil.

 N/A Oui
currency

Code ISO 4217 pour la "base" ou devise de comptabilité utilisée par l'organisation (par exemple, USD pour les États-Unis) 50 €).

Pour les plans de partage des revenus: la devise spécifiée est utilisée pour votre plan.

Forfaits pour les tableaux des tarifs (modèle de facturation) : il en va de même pour les forfaits de partage des revenus. Toutefois, vous pouvez remplacer le paramètre de devise par n'importe quelle devise prise en charge par le 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 des ajustements des détails du trafic enregistrés par les services d'API pour vos produits d'API ; peut être l'une des valeurs suivantes:

  • true: les ajustements sont activés.
  • "false" : les ajustements ne sont pas activés.
 N/A Non
hasBroker

Indicateur spécifiant si les revenus sont basés sur des revenus nets. Cette valeur peut être l'une des suivantes : les éléments suivants:

  • true: les revenus sont basés sur la valeur nette.
  • false: les revenus ne sont pas basés sur le montant net.
 N/A Non
hasSelfBilling

Indicateur demandant à la monétisation de générer une facture à autofacturation au lieu de revenus partage. Une facture à autofacturation est un document financier qui indique le montant en raison du développeur de l'application. Il sert de facture au fournisseur d'API au nom du développeur d'applications. Cette valeur peut être l'une des suivantes:

  • true: génère des factures à autofacturation au lieu des relevés de partage des revenus.
  • "false" : désactive l'autofacturation.
 N/A Non
hasSeparateInvoiceForProduct

Indicateur spécifiant si une facture distincte est générée pour chaque produit d'API. La peut être l'une des valeurs suivantes:

  • true: une facture distincte est générée pour chaque produit API.
  • "false" : aucune facture distincte n'est générée pour chaque produit API.
 N/A Non
id

ID de l'organisation.

 N/A Non
issueNettingStmt

Indicateur spécifiant si une instruction de mise en réseau est générée lors de la création de la facturation documents. Cette valeur peut être l'une des suivantes:

  • true: une déclaration de mise en correspondance est générée lors de la création des documents de facturation.
  • "false" : aucun relevé de mise en correspondance n'est 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

Avis de paiement net.

 N/A Non
nettingStmtPerCurrency

Indicateur spécifiant si une instruction de mise en réseau distincte est générée pour chaque devise utilisée. Cette valeur peut être l'une des suivantes:

  • true: une déclaration de compensation distincte est générée pour chaque devise utilisée.
  • "false" : aucune déclaration de compensation distincte n'est générée pour chaque devise utilisée.
 N/A Non
regNo

Numéro d'enregistrement de l'organisation. Le numéro que vous saisissez pour cet établissement est affiché au bas des documents de facturation.

 N/A Non
selfBillingAsExchOrg

Si les factures en auto-facturation sont activées, indique si l'échange est activé. pour les entreprises. Cette valeur peut être l'une des suivantes:

  • true: les factures en auto-facturation sont activées pour les organisations utilisant une place de marché.
  • "false" : l'autofacturation n'est pas activée pour les entreprises utilisant une place de marché.
 N/A Non
selfBillingForAllDev

Si les factures en auto-facturation sont activées, indique si elles sont activées pour tous développeurs d'applications. Par défaut, les factures à autofacturation ne sont générées que pour les développeurs d'applications a signé un accord avec le fournisseur d'API. Cette valeur peut être l'une des suivantes:

  • true: les factures en auto-facturation sont activées pour tous les développeurs d'applications.
  • "false" : l'autofacturation n'est pas activée pour tous les développeurs d'applications.
 faux Non
separateInvoiceForFees

Indicateur spécifiant si une facture distincte est publiée pour les frais. La valeur peut être l'une des options 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 d'organisation est enregistré pour la monétisation et est disponible pour utiliser.
  • INACTIF: le compte d'organisation est enregistré pour la monétisation, mais il ne l'est pas disponibles.
 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 pour l'utilisation d'un produit d'API. Les fonds sont déduits du solde du développeur lorsque le produit API est utilisé. Le développeur doit disposer d'une réserve prépayée suffisante pour acheter le produit API.
  • POSTPAID: le développeur est facturé mensuellement (par le biais d'une facture) pour l'utilisation de l'API. produits. Le développeur paie pour l'utilisation des produits d'API en fonction des conditions de paiement définies par le ou les forfaits inclus sur la facture.
  • BOTH: accepte les deux types de facturation. La valeur par défaut est PREPAID.

Consultez l'article Configurer des types de facturation prépayé et post-payé à 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 pour 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 :

  • Divulgée: le fournisseur d'API agit en tant qu'agent déclaré de développeur. Le revenu brut (y compris les taxes de vente) perçu auprès de l'utilisateur final est transmis au développeur. La commission du fournisseur d'API est collectée sur la développeur sous forme de facture de commission. Le fournisseur d'API ne gère pas taxe de vente perçue auprès de l'utilisateur final, sous la responsabilité du développeur pour déclarer la taxe de vente.
  • Non divulgué: le fournisseur d'API agit en tant qu'agent non divulgué de le développeur, déduit la taxe collectée auprès des utilisateurs finaux et la verse au des autorités fiscales locales. Le développeur facture les revenus nets au fournisseur d'API. de la part due au développeur (les taxes sur les ventes en moins et les dépenses commission.
  • Mixte: le fournisseur d'API agit en tant qu'agent développeur. Cependant, le fournisseur d'API paie la taxe de vente collectée abonnés à l'administration fiscale locale pour le compte du développeur. L'API transmet les revenus restants au développeur, puis facture les des frais de commission.
 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 d'immatriculation à 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'identification fiscale ou Le numéro de TVA ne s'applique pas dans tous les pays. Le nombre que vous saisissez pour cette 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 une adresse e-mail l'entrepôt.

 N/A Non
timezone

Identifiant du fuseau horaire des opérations de l'organisation, par exemple Amérique/New_York ou Europe/Paris. Abréviations des fuseaux horaires, comme UTC, EST (Eastern (heure normale d'Europe centrale) 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: