GET/Projects

Esta API devuelve la configuración actual de su proyecto.

Esta API proporciona una instantánea para asistir con las operaciones, y la estructura de respuesta puede cambiar sin previo aviso debido a actualizaciones del servicio.

Encabezado de Autenticación

La API de ARGOS utiliza la clave secreta en el encabezado x-api-key para autenticación. Puede encontrar su clave secreta en la configuración del proyecto en el dashboard. Al realizar solicitudes API, incluya su clave API en el encabezado x-api-key de la siguiente manera:

x-api-key: {yourAPIKey}

Solicitud

Parámetros de consulta

string

Puede verificar los valores actuales de configuración para una categoría específica.El filtrado es posible pasando una cadena separada por comas. Se agregarán categorías adicionales en el futuro.Valores posibles: managementEjemplo: category=management

curl -X GET 'https://rest-api.argosidentity.com/v3/projects/settings?category=management' \
-H 'x-api-key: {yourAPIKey}'

Respuesta

Respuesta exitosa

string

Identificador único para la solicitud API emitido por ARGOS. Incluir el traceId en su consulta le ayudará a obtener una respuesta más rápida.

object

Información actual de configuración del proyecto.

Mostrar Propiedades

object

Información de configuración relacionada con la gestión del proyecto.

Mostrar Propiedades de management

object

Estado actual basado en el sistema de control de envíos. Devuelve valor inactivo cuando la operación del sistema está detenida.
“activateBlocking” no se verá afectado por actualizaciones dentro de la misma versión.

Mostrar Propiedades

boolean

Si el sistema de control de envíos está activado.

string

La hora en que se activó por última vez el control de envíos (ISO8601).

array

Información de administradores almacenada en el dashboard.

string

Descripción del proyecto configurada en el dashboard.

string

URL de política de privacidad configurada en el dashboard.

string

URL de retorno configurada en el dashboard.

object

Configuración de opciones dentro de la URL de retorno.

Mostrar Propiedades

boolean

Si se incluye el campo personalizado 1

boolean

Si se incluye el campo personalizado 2

boolean

Si se incluye el campo personalizado 3

boolean

Si se incluye el email

boolean

Si se incluye el estado KYC

boolean

Si se incluye el ID de submission

boolean

Si se incluye el ID de usuario

boolean

Si se omite la página de resultados

boolean

Si el cifrado está habilitado

string

URL de términos de uso almacenada.

object

Lista de IPs permitidas para acceso al dashboard y API.

Mostrar Propiedades

array

Lista de IPs permitidas para acceso al dashboard

array

Lista de IPs permitidas para acceso a la API

string

Nombre del proyecto configurado.

string

Estado operacional actual del proyecto. Contacte al administrador de ARGOS si desea cambiarlo.Valores posibles: Trial, Test, Service, Closed

object

Configuración de webhook almacenada en el proyecto.

Mostrar Propiedades

string

Hora de registro del webhook

string

URL para recibir webhooks

array

Lista de miembros del webhook

Mostrar Propiedades de miembros

string

Nombre del miembro del webhook

string

Hora en que se agregó el miembro del webhook (ISO8601)

string

Email del miembro del webhook

{
  "traceId": "019a57b8-2bca-73de-94f0-220def0b60ee",
  "item": {
    "management": {
      "activateBlocking": {
        "activate": false
      },
      "admins": [
        "test@argosidentity.com"
      ],
      "description": " ",
      "formPrivacyPolicyUrl": " ",
      "formReturnUrl": " ",
      "formReturnUrlConfig": {
        "cf1": false,
        "cf2": false,
        "cf3": false,
        "email": false,
        "kycStatus": false,
        "submissionId": false,
        "userId": false,
        "skipResultPage": false,
        "isEncrypted": false
      },
      "formTermsOfUseUrl": " ",
      "ipWhitelist": {
        "admin": [],
        "api": []
      },
      "name": "test-project",
      "projectStatus": "open",
      "webhook": {
        "createTime": "2025-05-07T09:07:28.775Z",
        "url": "https://test.argosidentity.com",
        "members": [
          {
            "name": "test-member",
            "addDate": "2025-06-10T01:35:07.053Z",
            "email": "test@argosidentity.com"
          }
        ]
      }
    }
  }
}

Respuesta de error

Códigos de Error

statusCode	code	message
400	BAD_REQUEST	Invalid query parameters
400	INVALID_CATEGORY	Invalid category parameter: [invalid categories]

{
  "traceId": "018f1234-5678-90ab-cdef-123456789abc",
  "code": "BAD_REQUEST",
  "message": "Invalid query parameters"
}

Descripción General

Referencia API

Encabezado de Autenticación

Solicitud

Parámetros de consulta

Respuesta

Respuesta exitosa

Respuesta de error

​Encabezado de Autenticación

​Solicitud

​Parámetros de consulta

​Respuesta

​Respuesta exitosa

​Respuesta de error

Encabezado de Autenticación

Solicitud

Parámetros de consulta

Respuesta

Respuesta exitosa

Respuesta de error