Este documento ofrece a usuarios sin conocimientos técnicos una guía paso a paso sobre cómo usar la API pública de Appcues para añadir usuarios a un segmento de forma masiva. Este método de subida masiva de usuarios a un segmento resulta útil al crear un segmento grande con IDs de usuario.

Paso 1: Obtenga su clave API pública y su secreto

Para usar cualquier punto final de la API pública, necesitarás obtener estos dos datos de tu cuenta de Studio. A continuación, te explicamos cómo:

• Vaya a la página de configuración de su cuenta y haga clic en la pestaña “Claves API”: https://studio.appcues.com/settings/keys .

• Haga clic en “Crear clave”, asígnele un nombre a la clave y un nivel de permiso (en este caso, “Editor” está bien) y haga clic en “Crear”.

• En la siguiente pantalla, deberás copiar y pegar los valores de la clave API y del secreto en algún lugar para usarlos más adelante.

Paso 2: Crear el segmento

Ahora que tienes tu clave API y tu secreto, ¡puedes empezar a usar la API! Primero, necesitas crear un segmento.

1. Reemplace ACCOUNT_ID con el ID de su cuenta de Studio.
2. Reemplace API_KEY con la clave API del paso 1, seguida de dos puntos.
3. Reemplace API_SECRET con el secreto del paso 1.
4. Dale al Segmento un nombre y una descripción (cada uno entre comillas).

curl https://api.appcues.com/v2/accounts/ACCOUNT_ID/segments \
-u API_KEY:API_SECRET \
-H 'Content-type: application/json' \
-d '
{
"name": "My best friends",
"description": "A complete list of my best friends"
}
'

Una vez que el comando esté listo, puede llamar a la API. Copie y pegue el comando en la terminal que prefiera (usamos la terminal MAC, pero las mismas instrucciones se aplican también al símbolo del sistema de Windows/Linux) y presione Enter. Si la llamada se realizó correctamente, debería ver un mensaje como este, que incluye el ID del segmento:

{"created_at":"2022-02-03T18:23:33.178Z","created_by":"de0138b9-0a84-498e-8a09-78a23ddab4b
6-02","description":"Feb 3 Demo","id":"-Mv-owpQUFrI5RFTdh5_","name":"Segment Upload Demo F
eb 3","updated_at":"2022-02-03T18:23:33.178Z","updated_by":"de0138b9-0a84-498e-8a09-78a23d
dab4b6-02","url":"https://api.appcues.com/v2/accounts/94742/segments/-Mv-owpQUFrI5RFTdh5
_"}

También puedes comprobar en Studio que se ha creado el Segmento.

Paso 3: Cargar los ID de usuario al segmento

Una segunda llamada a la API le permitirá agregar una lista masiva de ID de usuario al segmento. La forma más sencilla de usar esta llamada es hacer referencia a un archivo CSV, que consta de una sola columna de ID de usuario. Este archivo puede incluir tantos ID de usuario como desee, pero solo se acepta la propiedad "userID".

1. Reemplaza ACCOUNT_ID con el ID de tu cuenta de Studio. Si no sabes cuál es, puedes encontrarlo en la página de Configuración .
   
2. Reemplace SEGMENT_ID con el ID del segmento que creó en el paso 2.
3. Reemplace API_KEY con la clave API del paso 1, seguida de dos puntos, y luego reemplace API_SECRET con el secreto del paso 1.
4. Reemplace ruta/a/archivo/csv con el nombre del archivo csv (mantenga el @ donde está).

curl https://api.appcues.com/v2/accounts/ACCOUNT_ID/segments/SEGMENT_ID/add_user_ids \
-u API_KEY:API_SECRET \
-F file=@path/to/file.csv

Copia y pega el comando en la Terminal y pulsa Intro. Puedes usar la Terminal de Mac o el Símbolo del sistema de Windows/Linux.

Si la llamada fue exitosa, deberías ver un mensaje como este:

{"job_id":"c5abb279-85d1-4c8b-9930-f37a0460a82f","job_url":"https://api.appcues.com/v2/acc
ounts/94742/jobs/c5abb279-85d1-4c8b-9930-f37a0460a82f","status":202,"title":"Accepted"}

Ahora esa lista de usuarios calificará para este segmento. Verás dos cambios en Studio:

1. El segmento tendrá una condición como esta:

2. Los usuarios que pertenecen a la lista tendrán una propiedad en su perfil de usuario como esta:

¡Ahora tienes un segmento listo para usarse para segmentar!