Applicazione dei limiti di monetizzazione nei proxy API

Questa pagina si applica a Apigee e Apigee ibrido.

Visualizza la documentazione di Apigee Edge.

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

Aggiunta di un criterio di autenticazione

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

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

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

    Pagina Criteri comuni della procedura guidata di creazione del proxy con la chiave API selezionata

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

    Scheda sviluppatore nell'editor proxy API che mostra il criterio VerifyAPIKey collegato al PreFlow

Per ulteriori informazioni, consulta:

Applicare gli abbonamenti degli sviluppatori ai prodotti 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, la norma MonetizationLimitsCheck genera un errore e blocca la chiamata API.

Se non esiste un piano tariffario 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 della norma MonetizationLimitsCheck e in riferimento alla variabile di flusso mint.

Collega la norma MonetizationLimitsCheck a un proxy API in uno dei seguenti modi:

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

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

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

    Scheda Sviluppatore nell'editor proxy API che mostra il criterio MonetizationLimitsCheck collegato a PreFlow dopo il criterio VerifyAPI

Per ulteriori informazioni, consulta:

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 inoltre 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.

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

  • Quando crei un proxy API con la procedura guidata di creazione del proxy, seleziona Impose quote per app (Imposta quote per app) nella sezione Quote della pagina Criteri comuni, come mostrato nella figura seguente.

    Pagina Criteri comuni della procedura guidata Crea proxy in cui è selezionata l'opzione Imponi quote per app

  • Quando sviluppi un proxy API, collega il criterio Quota al flusso di richieste nel PreFlow del proxy API dopo il criterio VerifyAPIKey o VerifyAccessToken, come mostrato nella figura che segue.

    Scheda Sviluppatore nell'editor proxy API che mostra i criteri per le quote collegati a PreFlow

Modifica il criterio 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>

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 in riferimento alle variabili di flusso dei criteri per le quote.

Per ulteriori informazioni, consulta: