Applicazione dei limiti di monetizzazione nei proxy API

Questa pagina si applica ad Apigee e Apigee hybrid.

Visualizza la documentazione di Apigee Edge.

Applica i limiti di monetizzazione collegando le norme ai proxy API associati a un prodotto API monetizzato, come descritto nelle sezioni seguenti.

Aggiunta di un criterio di autenticazione

La monetizzazione di Apigee utilizza il criterio VerificationAPIKey o VerificationAccessToken per determinare se una richiesta in entrata è monetizzabile controllando il piano tariffario attivo pubblicato.

Collega il criterio VerificationAPIKey o il criterio VerificationAccessToken a un proxy API in uno dei seguenti modi:

• Quando crei un proxy API utilizzando la procedura guidata Crea proxy, seleziona Chiave API o OAuth 2.0 nella sezione Sicurezza: Autorizzazione della pagina Criteri comuni. Ad esempio:

  

• Quando sviluppi un proxy API, collega il criterio VerificationAPIKey o VerificationAccessToken al flusso di richiesta come primo criterio nel PreFlow del proxy API. Ad esempio:

  

Per ulteriori informazioni, vedi:

• Collegare un criterio a un flusso
• Verificare i token di accesso
• Monitoraggio e debug del criterio di autenticazione mediante Debug

Applicazione di abbonamenti degli sviluppatori a prodotti basati su API

Collega il criterio MonetizationLimitsCheck ai proxy API per applicare gli abbonamenti degli sviluppatori al prodotto API. In particolare, il criterio viene attivato se lo sviluppatore di app che accede all'API non ha acquistato un abbonamento al prodotto API associato. In questo caso, il criterio MonetizationLimitsCheck segnala un errore e blocca la chiamata API.

Se non esiste un piano del tasso di monetizzazione per il prodotto API recuperato durante l'esecuzione della chiamata proxy, il prodotto viene considerato non monetizzato, il criterio MonetizationLimitsCheck non recupera ulteriori dati e la norma non ha alcun effetto.

Quando colleghi il criterio MonetizationLimitsCheck a un proxy API, le variabili di flusso mint.limitscheck.* e mint.subscription_* vengono compilate, come descritto in Debug delle norme MonetizationLimitsCheck e il riferimento alla variabile di flusso mint.

Nota: per evitare che vengano fatturate transazioni specifiche, puoi utilizzare la variabile di monetizzazione transactionSuccess. Per ulteriori informazioni sull'utilizzo della variabile transactionSuccess, consulta la sezione Variabili di monetizzazione.

Puoi collegare il criterio MonetizationLimitsCheck a un proxy API in uno dei seguenti modi:

• Quando crei un proxy API utilizzando la procedura guidata Crea proxy, seleziona Applica limiti di monetizzazione nella pagina Norme comuni, come mostrato nella figura seguente.

  

• Quando si sviluppa un proxy API, collega MonetizationLimitsCheckPolicy al flusso di richiesta nel PreFlow del proxy API dopo il criterio VerificationAPIKey o VerificationAccessToken, come mostrato nella figura seguente.

  

Per ulteriori informazioni, vedi:

• Creazione di un proxy API
• Collegare un criterio a un flusso
• Eseguire il debug delle norme MonetizationLimitsCheck mediante la funzionalità di debug
• Norme per il controllo dei limiti di monetizzazione

Applicazione delle quote di monetizzazione nei proxy API

Nota: se aggiungi una quota dopo che il prodotto API è stato in uso, il calcolo della quota inizia dalla successiva transazione monetizzata.

Una quota definisce il numero di richieste consentite per un prodotto API in un determinato periodo di tempo. Per applicare le quote per la monetizzazione, ti consigliamo di impostare il valore della quota durante la creazione di un prodotto API.

La definizione di un valore di quota per un prodotto API non applica automaticamente limitazioni al numero di chiamate che possono essere effettuate tramite il prodotto API. Devi anche aggiungere criteri per le quote ai proxy API a cui fa riferimento il prodotto API per garantire che venga applicato il valore di quota definito a livello di prodotto API.

Puoi collegare il criterio per le quote a un proxy API in uno dei seguenti modi:

• Quando crei un proxy API utilizzando la procedura guidata per la creazione del proxy, seleziona Impossi quote per app nella sezione Quote della pagina Criteri comuni, come mostrato nella figura seguente.

  

• Quando si sviluppa un proxy API, collega il criterio per le quote al flusso di richiesta nel PreFlow del proxy API dopo il criterio VerificationAPIKey o VerificationAccessToken, come mostrato nella figura seguente.

  

Modifica i criteri per le quote per consentire all'elemento <UseQuotaConfigInAPIProduct> di utilizzare la configurazione della quota definita a livello di prodotto API.

Ad esempio:

<Quota continueOnError="false" enabled="true" name="impose-quota">
    <DisplayName>Impose Quota</DisplayName>
    <UseQuotaConfigInAPIProduct stepName="verify-api-key">
        <DefaultConfig>
            <Allow>10000</Allow>
            <Interval>1</Interval>
            <TimeUnit>week</TimeUnit>
        </DefaultConfig>
    </UseQuotaConfigInAPIProduct>
    <Distributed>true</Distributed>
    <Synchronous>true</Synchronous>
    <StartTime>2021-01-01 12:00:00</StartTime>
</Quota>

Note:

• Puoi definire la configurazione predefinita <DefaultConfig> da utilizzare se la configurazione della quota non è definita nel prodotto API, ma la configurazione della quota definita a livello di prodotto API ha la precedenza.
• Quando aggiungi l'elemento <UseQuotaConfigInAPIProduct> al criterio per le quote, Apigee ignora qualsiasi elemento secondario <Allow>, <Interval> e <TimeUnit> di <Quota>.

Quando colleghi il criterio per le quote a un proxy API, vengono compilate le variabili di flusso ratelimit.*, come descritto in Debug del criterio per le quote e nel riferimento alle variabili di flusso del criterio per le quote.

Per ulteriori informazioni, vedi:

• Collegare un criterio a un flusso
• Debug del criterio per le quote mediante Debug
• Criteri per le quote