Saltar al contenido principal

Alcance de la clave

Restricción por proyecto

El campo Proyecto (Project) limita una clave de API a un proyecto concreto:

  • Cualquiera (Any) —la clave tiene acceso a todos los proyectos de la cuenta
  • Un proyecto concreto —la clave trabaja solo con los datos del proyecto seleccionado

La restricción se comporta de forma distinta según el método. En los métodos de listado es un filtro: la respuesta es exitosa, pero contiene solo los datos del proyecto. En los métodos que se dirigen a una factura o billetera concreta, una solicitud por el objeto de otro proyecto se rechaza con Restricted project.

MétodoClave restringida a un proyecto
billing/balancesDatos a nivel de cuenta; la restricción no se aplica
billing/historyLas operaciones del proyecto más las operaciones a nivel de cuenta —recargas y bonos
billing/tariffsTarifa y volumen solo del proyecto de la clave
invoices/listResultados solo del proyecto de la clave
payments/listResultados solo del proyecto de la clave
statistics/invoicesSe calculan solo para el proyecto de la clave
statistics/paymentsSe calculan solo sobre las facturas del proyecto de la clave
invoices/createEl projectId de la solicitud debe coincidir con el proyecto de la clave
invoices/cancelLa factura de otro proyecto es inaccesible
invoices/bindPaymentLa factura de otro proyecto es inaccesible

Restricción por alcance

El alcance define qué métodos de la API puede usar la clave. Es un campo obligatorio de selección múltiple.

Una llamada a un método fuera del alcance de la clave se rechaza con Restricted scope.

Combinación de restricciones

Las restricciones por proyecto y por alcance funcionan juntas. Por ejemplo, si una clave está limitada a los métodos de facturas y vinculada a un proyecto concreto:

  • Solo están disponibles los métodos de facturas
  • Los datos se filtran únicamente al proyecto indicado
  • Las solicitudes de pagos o estadísticas se rechazan
  • Las solicitudes de datos de otros proyectos se rechazan