Empieza con la API REST

La API REST de Scratcher permite que tus propios sistemas lean tus campañas, leads y listas, añadan y actualicen leads y gestionen productos. Este artículo es para el desarrollador que la configura. La API está incluida a partir del plan Basic.

Crea un token de acceso

1. Ve a Configuración > API (en Desarrolladores).
2. En Tokens de acceso personal, haz clic en Crear token de acceso personal.
3. Ponle un Nombre, como «Data warehouse», y elige los Permisos que necesita. Dale solo el acceso que necesite.
4. Haz clic en Guardar y copia el token que aparece en Secreto. Solo lo verás una vez, así que guárdalo en un lugar seguro, por ejemplo en un gestor de contraseñas.

Un token pertenece a tu usuario y puede acceder a todas las cuentas de las que eres miembro. Para quitar el acceso, abre el token y haz clic en Revocar.

Permisos

• read:campaigns: leer campañas
• read:lists: leer listas de leads
• read:leads y write:leads: leer, crear, actualizar y eliminar leads
• read:placements y write:placements: leer y gestionar ubicaciones
• read:products y write:products: leer y gestionar productos

Haz una petición

La URL base es https://platform.scratcher.io/api/v1/. Envía el token en la cabecera Authorization:

curl https://platform.scratcher.io/api/v1/accounts \ -H "Authorization: Bearer YOUR_TOKEN" \ -H "Accept: application/json" 

Endpoints principales

• GET /me: el usuario al que pertenece el token
• GET /accounts: las cuentas a las que tienes acceso
• GET /accounts/{account}/campaigns y /campaigns/{campaign}: tus campañas
• GET /accounts/{account}/campaigns/{campaign}/leads: los leads de una campaña, con premios, códigos y consentimientos aceptados
• GET /accounts/{account}/lists y /lists/{list}/leads: listas de leads y sus leads, además de POST, PUT y DELETE para gestionar leads
• /accounts/{account}/products: productos
• /accounts/{account}/placements: ubicaciones

Los resultados se paginan con ?page=. El límite es de 60 peticiones por minuto por usuario.

La referencia completa, con ejemplos y una colección de Postman, está en la documentación de referencia de la API. El botón Referencia de la API de la plataforma también enlaza a ella.

Apps OAuth

Si creas una app a la que se conectan otros usuarios de Scratcher, regístrala en Mis apps > Crear app con un Nombre de la aplicación y una URI de redirección. Obtendrás un ID de cliente y un Client secret. El secreto solo se muestra una vez. Las apps que la gente ha aprobado aparecen en Apps autorizadas, desde donde se pueden revocar.