Listar integraciones

Utiliza este punto de conexión para obtener una lista de las integraciones existentes.

Nota

Para utilizar este punto de conexión, deberás generar una clave de API con el permiso cdi.integration_list.

Límite de velocidad

Este punto de conexión tiene un límite de velocidad de 50 solicitudes por minuto.

Parámetros de consulta

Cada llamada a este punto de conexión devolverá 10 elementos. Para una lista con más de 10 integraciones, utiliza el encabezado Link para recuperar los datos en la página siguiente, como se muestra en el ejemplo de respuesta.

Ejemplo de solicitud

Sin cursor

1
2
3
curl --location --request GET 'https://rest.iad-03.braze.com/cdi/integrations' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR-REST-API-KEY'

Con cursor

1
2
3
curl --location --request GET 'https://rest.iad-03.braze.com/cdi/integrations?cursor=c2tpcDow' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR-REST-API-KEY'

Respuesta

Ejemplo de respuesta satisfactoria

El código de estado 200 podría devolver el siguiente cuerpo de respuesta.

Nota

El encabezado Link no existirá si hay 10 integraciones o menos en total. En las llamadas sin cursor, prev no se mostrará. Al consultar la última página de elementos, next no se mostrará.

1
Link: </cdi/integrations?cursor=c2tpcDow>; rel="prev",</cdi/integrations?cursor=c2tpcDoxMDA=>; rel="next"

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
{
  "results": [
    {
      "integration_id": (string) integration ID,
      "app_group_id": (string) app group ID,
      "integration_name": (string) integration name,
      "integration_type": (string) integration type,
      "integration_status": (string) integration status,
      "contact_emails": (string) contact email(s),
      "last_updated_at": (string) last timestamp that was synced in ISO 8601,
      "warehouse_type": (string) data warehouse type,
      "last_job_start_time": (string) timestamp of the last sync run in ISO 8601,
      "last_job_status": (string) status of the last sync run,
      "next_scheduled_run": (string) timestamp of the next scheduled sync in ISO 8601
    }
  ],
  "message": "success"
}

Solución de problemas

La siguiente tabla enumera los posibles errores devueltos y sus pasos asociados para la solución de problemas.

Para obtener más códigos de estado y mensajes de error asociados, consulta Errores fatales y respuestas.