Uso de API keys

Última actualización:

Prisma Campaigns proporciona una forma segura de recuperar información de clientes desde su base de datos utilizando API keys. Esta funcionalidad está diseñada específicamente para la recuperación de datos de clientes y requiere autenticación adecuada para cada solicitud.

Autenticación

Cada solicitud para recuperar información de clientes requiere una autenticación mediante un token Bearer. La API key debe ser generada específicamente para su instancia de Prisma Campaigns e incluida en el encabezado Authorization de su solicitud.

Parámetro del encabezado Formato del valor
Authorization Bearer SU-CLAVE-DE-API
Accept application/json

Recuperación de información de clientes

Para recuperar información de clientes, necesitará realizar una solicitud GET al endpoint de búsqueda de clientes. La estructura de la URL incluye el subdominio de su instancia y el identificador del cliente que desea consultar.

URL Método
https://SU-SUBDOMINIO.prismacampaigns.com/api/customers/find/ID-CLIENTE GET

Ejemplo de solicitud

A continuación, se muestra un ejemplo utilizando curl para recuperar información de un cliente:

curl -H "Authorization: Bearer b1aaa1a0-05b0-436c-b4ec-804c5239e47a" \
     -H "Accept: application/json" \
     https://bankofholland.prismacampaigns.com/api/customers/find/bFNsbkhoY3ZKRmdvNVAzVm1LNlJjd90z

donde b1aaa1a0-05b0-436c-b4ec-804c5239e47a es la API key y bFNsbkhoY3ZKRmdvNVAzVm1LNlJjd90z es el identificador del cliente.

Formato de respuesta

La respuesta se devolverá en formato JSON, conteniendo la información del cliente disponible en la base de datos de su instancia de Prisma Campaigns. Por ejemplo:

{
  "tags":[17592213056255],
  "name":"John",
  "updated-by":[{"id":17592213056257}],
  "last-update":1678869745683,
  "mobile-registrations":null,
  "id":"bFNsbkhoY3ZKRmdvNVAzVm1LNlJjd90z",
  "last_name":"Doe",
  "Email_address":"johndoe@bofh.com",
  "full_name":"John Doe"
}

Consideraciones de seguridad

  1. Mantenga su API key segura y nunca la exponga en código del lado del cliente.
  2. Cada API key es específica para una instancia de Prisma Campaigns.
  3. Rote regularmente sus API keys como parte de sus prácticas de seguridad.

Artículos relacionados