Autorización y formato de solicitud de la API del servidor

Autorización

Las solicitudes a la API deben autenticarse con tu clave de API secreta o pública como cabecera de autorización. Puedes encontrarlas en App Settings. El formato del valor es Api-Key {your-secret-api-key}, por ejemplo, Api-Key secret_live_....

Important

Las claves de API son específicas de cada app. Si tienes varias apps, asegúrate de usar claves distintas para cada una.

Formato de solicitud

Cabeceras

Las solicitudes a la API del servidor requieren cabeceras específicas y un cuerpo en JSON. Usa los detalles a continuación para estructurar tus solicitudes.

CabeceraDescripción
adapty-profile-id

El ID de perfil de Adapty del usuario. Visible en el campo Adapty ID en Adapty Dashboard -> Profiles -> página del perfil específico.

Es intercambiable con adapty-customer-user-id; usa cualquiera de los dos.

adapty-customer-user-id

El ID del usuario en tu sistema. Visible en el campo Customer user ID en Adapty Dashboard -> Profiles -> página del perfil específico.

Es intercambiable con adapty-profile-id; usa cualquiera de los dos.

⚠️ Solo funciona si identificas usuarios en tu app en el código de tu app usando el SDK de Adapty.

adapty-platform(opcional) Especifica la plataforma del dispositivo en el que está instalada la app. Recomendamos establecer este parámetro en las solicitudes Crear perfil y Actualizar perfil al modificar el objeto Installation Meta, ya que depende del dispositivo que utilice el usuario y un mismo usuario puede tener varios dispositivos. Valores posibles: iOS, macOS, iPadOS, visionOS, Android o web.
Content-TypeEstablécelo en application/json para que la API procese la solicitud.

Cuerpo

La API espera un cuerpo en formato JSON con los datos necesarios para la solicitud.

Límites de frecuencia

Los límites de frecuencia se aplican por clave de API, y el límite asignado a tu app está vinculado a tu clave — no existe una cifra única que sea válida para todas las apps. Si estás dimensionando una integración de alto volumen o empiezas a recibir respuestas 429, consulta con soporte cuál es el límite que se aplica a tu app.

Dos aspectos a tener en cuenta al diseñar:

  • El límite es una tasa sostenida, no un presupuesto por minuto. Las solicitudes se distribuyen a lo largo de la ventana y solo se absorbe un breve pico por encima de la tasa, por lo que una tasa de solicitudes constante rinde considerablemente más que enviar todo el tráfico de un minuto de golpe.
  • Algunos endpoints tienen su propio límite, más bajo. Crear transacción de moneda virtual permite 600 solicitudes por minuto por app de forma predeterminada, independientemente del límite global de tu app.

Requests over a limit fail with 429 Too Many Requests. Retry with backoff, and honor the Retry-After header when the response carries one.

Rotar claves de API

Si necesitas rotar las claves de API secretas:

  1. En Settings → General, haz clic en Generate new key y luego en el icono de papelera junto a la clave antigua.
  2. Actualiza la clave utilizada en tu app.

Próximos pasos — solicitudes: