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 associando i criteri 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 VerifyAPIKey o VerifyAccessToken per determinare se una richiesta in arrivo è monetizzabile controllando il piano tariffario pubblicato attivo.

Collega il criterio VerifyAPIKey o VerifyAccessToken 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:

    Pagina Criteri comuni della procedura guidata Crea proxy con la chiave API selezionata

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

    Scheda Sviluppatore nell'editor del proxy API che mostra il criterio VerifyAPIKey associato al flusso PreFlow

Per ulteriori informazioni, vedi:

Applicazione degli abbonamenti degli sviluppatori ai prodotti API

Collega il criterio MonetizationLimitsCheck ai proxy API per applicare gli abbonamenti degli sviluppatori al prodotto API. Nello specifico, 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 genera un errore e blocca la chiamata all'API.

Se non esiste un piano tariffario per la monetizzazione del prodotto API recuperato durante l'esecuzione della chiamata proxy, il prodotto viene considerato non monetizzato, il criterio MonetizationLimitsCheck non recupera ulteriori dati e il criterio 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 Eseguire il debug del criterio MonetizationLimitsCheck e nel riferimento alla variabile di flusso mint.

Collega 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 Criteri comuni, come mostrato nella figura seguente.

    Pagina Criteri comuni della procedura guidata Crea proxy con il controllo Applica limiti selezionato

  • Quando sviluppi un proxy API, collega il criterio MonetizationLimitsCheckPolicy al flusso di richiesta nel PreFlow del proxy API dopo il criterio VerifyAPIKey o VerifyAccessToken, come mostrato nella figura seguente.

    Scheda Sviluppatore nell'editor del proxy API che mostra il criterio MonetizationLimitsCheck collegato al flusso precedente dopo il criterio VerifyAPI

Per ulteriori informazioni, vedi:

Applicazione delle quote di monetizzazione nei proxy API

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 quando crei 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 di quota ai proxy API a cui fa riferimento il prodotto API per assicurarti che il valore della quota definito a livello di prodotto API venga applicato.

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

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

    Pagina Criteri comuni della procedura guidata Crea proxy con l'opzione Imposta quote per app selezionata

  • Quando sviluppi un proxy API, collega il criterio per le quote al flusso di richieste nel PreFlow del proxy API dopo il criterio VerifyAPIKey o VerifyAccessToken, come mostrato nella figura seguente.

    Scheda Sviluppatore nell'editor di proxy API che mostra i criteri di quota associati al PreFlow

Modifica il criterio per le quote per attivare l'elemento <UseQuotaConfigInAPIProduct> per utilizzare la configurazione delle quote 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>

Quando colleghi il criterio quota a un proxy API, le variabili di flusso ratelimit.* vengono completate, come descritto in Eseguire il debug del criterio quota e nella sezione di riferimento sulle variabili di flusso del criterio quota.

Per ulteriori informazioni, vedi: